prashantsr / pxdocs

Source for upcoming version of docs.portworx.com

Portworx Documentation

A hugo implementation of the Portworx documentation.

Contributing to the docs

• Click the Fork button in the upper-right area of the screen to create a copy of this repository in your GitHub account. This copy is called a fork.
• Make any changes you want in your fork, and when you are ready to send those changes, go to your fork and create a new pull request.
• Once your pull request is created, assign the PR to a reviewer who is the SME (subject matter expert). As the owner of the pull request, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer.

Below are useful pages that will be useful if you are contributing to the docs.

• Recommended git workflow for contributing
• Tip and tricks for editing content
• Documentation on search functionality
• Documentation on version dropdown
• Recommended editors
  • Visual Code
  • Atom

Running the site locally

To develop the docs site locally - first ensure you have docker installed.

Pull in the theme from the pxdocs-tooling repo using below command:

make update-theme

Now, launch the website locally using:

make develop

You can then view the site in your browser at http://localhost:1313. As you edit content in the content folder - the browser will refresh automatically as you save files.

Updating the theme

It's important to make sure the theme the docs site uses is up to date. To do this:

make update-theme

This will pull in the latest content from pxdocs-tooling - make sure you git commit once you have updated the theme.

Make sure you update the theme for each of the version branches if the theme changes.

If you want to make changes to the templates or CSS - these files live in the layouts and static folder of the pxdocs-tooling repo. Make the changes there and then re-update each of the version branches.

Deployment to production

Deployment of your changes is handled by Travis upon a git push to the git repo. Once you have made changes and viewed them locally - a git push of the version branch you are working on will result in the content being deployed into production.