Ask or search…
K

Contributing and Feedback Guide

We wish to express our gratitude for your dedication in providing feedback and contributing to the refinement of our training manuals. We are committed to enhancing these documents through the valuable input of our community, and we highly value any feedback you may have to offer. Whether it pertains to further documentation or code contributions, the identification of grammatical issues, or the submission of suggestions and improvements, your engagement is sincerely appreciated.
Should you wish to peruse the manual, it is accessible via the following link:
For those inclined to actively contribute and effect changes in the manuals, we have prepared a dedicated page that will assist in guiding you through the contribution process. This resource will detail the tools we employ and outline the sequential steps necessary for successful contributions.

Providing Feedback

There are a few ways you can provide feedback:

Overview and basics

  • The source code for this manual is hosted on Github and uses a service called Gitbook for publishing its documentation.
  • The manuals are written using Markdown mark up language.
  • The GovCMS content administration manual is part of the govcms-training distribution which also includes the GovCMS site builder manual.
  • Both these manuals share a public Roadmap which lists out issues and feature requests on a kanban board.
  • Click here to view the current issue queue for the GovCMS content administration manual.
  • All contributions must be licensed under CC BY-SA 3.0 AU.

Getting started and prerequisites

For contributing to the manual, the following is needed to get started:

Gitbook & GitHub integration

  • master: reserved for production only. The master branch is synced with the Gitbook page for this manual and is only editable by maintainers of this repo.
    • Any changes merged in to master will automatically be reflected on Gitbook.
  • develop: the default branch used for development and content changes.

How to contribute

Trying to edit or create a file in this repository will create your fork automatically. You can then edit pages or create new pages, and commit your changes and file a pull requests one document/issue at a time.
For content changes or new pages, you can use the GitHub online editor:
  • Open the page you want to edit on your forked version of the repo on GitHub and press the Edit icon (pen icon).
  • When have finalised your changes, scroll to the bottom of the page and write a description of the changes you're proposing under the "Commit changes" ection. Then select Create a new branch for this commit and start a pull request and click on Propose file change. This will direct you to the Pull request page
  • On the Pull request page, write a short comment explaining why are proposing those changes and publish your pull request clicking on Create pull request.
Any pull request should be based on the develop branch. We will not consider pull requests made to master.
For more information, please see see Using Pull Request and Fork a Repo if you're not familiar with Pull Requests.

Review process

Moderators will review and comment on pull requests. We may suggest changes, improvements, or alternatives, in which case the original contributor will be tagged directly so follow-up instructions are clear. There may be times where moderators will make commits to your fork directly for clarity.

Community

If you have any other questions about contributing to our documentation, please reach out to [email protected] or join the online GovCMS Community Discourse.