Giter VIP home page Giter VIP logo

tech-stories's Introduction

Tech Stories

This repository contains the sources for the DB Systel Tech-Blog called "Tech Stories".

All code is licensed under Apache-2.0, Copyright 2023 by DB Systel GmbH.

For any usage outside of Deutsche Bahn websites and applications you must remove or replace any Deutsche Bahn brand and design assets as well as protected characteristics and trademarks.

Setup for local development

Prerequisites
  • Make sure you have wget installed.

Get compatible Java version

To work with DocToolchain for building the Microsite, you need to have Java installed. The Following command load the latest compatible Java version and installs it locally in path that’s accessible by DocToolchain.

./dtcw getJava

Build and Run

To quickly build the documentation with a docker container, use:

arch ./dtcw docker generateSite
arch ./dtcw docker previewSite

You can also run a local build and preview:

arch ./dtcw docker generateSite
arch ./dtcw docker previewSite

Get Started: Write an article

Create / Update your author profile

When writing an article, the first thing you need is an author profile (if not already exist). You will find the profiles in /src/docs/blog/profiles. If you already have a profile, be sure it’s up-to-date and probably refresh the information in it. If you don’t have a profile, you can scaffold a new profile using the generator which prompts you for some base information needed.

./dtcw local createAuthor

After you answered all questions, a new profile .adoc is created. Please check the content and add some additional information about you.

Create your Tech Story

Once your profile created and is up-to-date (see section above), you can create the Tech Story with it’s content. Therefore you can make use of the generator as well by running:

./dtcw local createStory

The generator will prompt you for the base information needed for a Tech Story. Once you filled out everything, the AsciiDoc File with all meta information is generated and you can directly start writing your content. Happy writing!

Build locally

To build the site locally, you can run:

./dtcw local generateSite

The artifacts for the static site are located in ./build/microsite/output. You can open / serve the index.html file using you favorite webserver.

tech-stories's People

Contributors

rdmueller avatar julianeschmidt avatar d-koppenhagen avatar mxmehl avatar jschirrmacher avatar morl99 avatar mannil avatar n0y avatar cornelius avatar dersvenhesse avatar

Stargazers

 avatar  avatar  avatar Kawasakai avatar Petrick avatar  avatar Gualter Barbas Baptista avatar

Watchers

 avatar  avatar  avatar Alexander Schmitt avatar  avatar

tech-stories's Issues

Site is down

Seems like the last PR put the site down for some reason 🙈

image

Feedback-Issue gibt nicht die Seite mit

Wenn ich auf den Feedback-Bereich klicke, dann kann ich ein Issue erstellen, aber die Seite wird im Issue nicht mitgegeben, wie das jetzt bei "Create an Issue" der Fall ist.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.