Making simple changes to the KubeStellar Docs/Website

Spotted a typo or other simple error in of our web documentation pages? Help us fix it quickly!

The Easy Way

For edits to a single page, we have enabled a suggest edits function in the site itself:

  1. Sign into Github in your browser.
  2. Open a second tab and visit the page in the website you wish to modify. (Make sure have selected the specific version of the docs with the dropdown in the masthead)
  3. Find and click on the Edit This Page (Pencil) icon near the upper right page
  4. A Github editor session will open for you and when you commit your changes, you will be presented with the option to create a corresponding PR.
  5. You may have to make some adjustments to the PR title, etc to fulfil some requirements for a PR.
  6. When your PR is created, it will automatically generate a site preview via Netlify to make reviewing the proposed changes easier

This page is an import of part of github.com/kubestellar/docs/CONTRIBUTING.md . The complete file is viewable there, or on the Detailed Contribution Guide page in this section of the website. Changes to this page content must be made in CONTRIBUTING.md on GitHub