Genesis platform documentation

Documentation is written using Markdown format.

Contribution

Now our community team is accepting contributions from all community members of genesis. All accepted contribution will be published to our official website.

For more details about what types of contribution we are accepting, please follow the link.

If you are willing to contribute, please follow the links below:

Internal contributor if you are an internal contributor currently working at Genesis.
External contributor if you are an external contributors not currently working at Genesis.

Stack Overflow

We have a Stack Overflow community, take a look if you have a Genesis Login or click here to get a new genesis login. We are encouraging our teams, costumers and contributors to participate to this community.

Installation

npm i

Local development

npm run start

This command starts a local development server and opens a browser window. Most changes are reflected live without having to restart the server.

Note that you need to prefix your url with /next/ in order to see your updated changes locally. For example, http://localhost:8080/operations/containerisation/healthchecks/ shows the most recently published docs version. To view the next version - the one that will be published at the next platform release, add /next/ to beginning of the url. For example, http://localhost:8080/next/operations/containerisation/healthchecks/

Build

npm run build

This command generates static content into the build directory.

Clear

npm run clear

This command clears the Docusaurus generated assets, caches, build artefacts etc. This is useful if you're not seeing your changes in the browser.

Regenerating `bundle`

To generate a new bundled file, simply run the following command from the package you wish to access.

npm run build

For example, in the foundation-ui repo we run the command above on the documentation-components under the showcase folder.

Ensure the package you intend to regenerate the file from has all the necessary dependencies.

Once you have the new regenerated file, paste the contents to docs.iife.min.js

Copy FE docs

Front-end documentation from foundation-ui can be pulled into this repo. To this, follow the steps below:

Add as a dependency in ./package.json.
Set up the config in ./plugins/api-docs/manifest.json.
Set up the sidebar.
Run with $ npm run start:copy-docs.
Once you have got feedback on the docs, you can lock it in via ./plugins/api-docs/processedMap.js.

rafaelnferreira/docs