LogoLogo
  • GovCMS8 Site Building Training Manual
  • Contributing and Feedback Guide
  • Software and module requirements
  • UNIT 1: FUNCTIONAL ANALYSIS
    • Overview
    • Layout of a GovCMS page
    • Regions in GovCMS
    • Planning your site
    • About our client
    • Understanding requirements
    • Audience analysis
    • User (visitor) personas
    • Define user stories
    • Roles and Permissions
      • Exercise 1.1: Configure account settings
    • Blocks in GovCMS
      • Exercise 1.3: Place Welcome message block
    • Site navigation
    • Footers
      • Exercise 1.4: Build the related links menu
      • Exercise 1.5: Assign the related links menu block to a region
      • Exercise 1.6: Configure the related links menu block
      • Exercise 1.7: Rearrange the main menu
    • Theme settings
      • Exercise 1.8: Change the logo
      • Exercise 1.9: Create a friendly error page
    • Unit 1 Summary
  • UNIT 2: DESIGNING AND PLANNING CONTENT
    • Designing and planning content
      • Exercise 2.1: Compare content types
    • Planning your site structure
    • Planning data entry and display
    • Discussion
      • Exercise 2.2: Design a content type in minutes
      • Exercise 2.3: Create a content type
    • Add and configure fields
      • Exercise 2.5: Modify an existing field
      • Exercise 2.6: Add a custom text field
      • Exercise 2.7: Review the field list report
    • Manage form display
      • Exercise 2.8: Testing content types
    • Unit 2 Summary
  • UNIT 3: MANAGE MEDIA
    • Manage Media
    • Customise image display with image styles
    • Review configuration of image media display
      • Exercise 3.1: Example use of image styles
      • Exercise 3.2: Add and configure a media field
      • Exercise 3.3 (Challenge): Change image size
    • Unit 3 Summary
  • UNIT 4: TAXONOMY - CATEGORISING CONTENT
    • Taxonomy - Categorising content
      • Exercise 4.1: Add new Vocabulary
      • Exercise 4.2: Add Taxonomy field to content types
    • About input options
      • Exercise 4.3: Add fields to content types
      • Exercise 4.4: Test the new vocuabulary
    • Editorial considerations
    • Prepare documentation for new staff onboarding
    • Content creation forms
    • Unit 4 Summary
  • UNIT 5: TEXT FORMATS AND RICH TEXT
    • Text formats and rich text
      • Exercise 5.1 (Optional): Set up the Rich Text editor
      • Exercise 5.2 (Challenge): Create a new text format
    • About cross-site scripting
    • Text formats
    • Unit 5 Summary
  • UNIT 6: CONTENT LISTING WITH VIEWS
    • Content listing with Views
      • Exercise 6.1: Build the employment news view
    • Views - Part 2
      • Exercise 6.3: A customised News and Media page
      • Exercise 6.4: Reuse a Views template
    • Related content by term
      • Exercise 6.5: Make a list of States/Territories block
      • Exercise 6.6: Build the related content block
      • Exercise 6.7: Configure data field and Event content type
      • Exercise 6.8 (Challenge): Extend Content type
      • Exercise 6.9: Modify an event listing for future dates
    • Customize the content administration experience
      • Exercise 6.10: Administration with View bulk operations
    • Unit 6 Summary
  • UNIT 7: URL ALIASES
    • URL Aliases
      • Exercise 7.1: URL aliases - Patterns
    • URL Redirects
      • Exercise 7.2: Configure redirects
      • Exercise 7.3: Breadcrumbs
    • Menu check
    • Unit 7 Summary
  • UNIT 8: SITE BUILDING EXERCISES
    • Site building exercices workshop
    • Extend content types with new fields
      • Exercise 8.1: Add an external link field
    • Agency reference link
      • Exercise 8.2: Create Agency References
    • Job list dropdown filter
      • Exercise 8.3: Configure the job listing
      • Exercise 8.4: Agency logo in Job Posting view
      • Exercise 8.5: Challenge exercises
    • Discussion
    • Views contextual filters
      • Exercise 8.6: Add About author block to News article
    • Further discussion and exercices
    • Employee list and custom profiles
      • Exercise 8.7: Set up profile fields
      • Exercise 8.8: Create a list of users
      • Exercise 8.9: Edit the existing view to filter out roles
      • Exercise 8.10: Create a custom layout
      • Exercise 8.11 (Challenge): An image gallery
    • Unit Summary
    • Discussion
  • UNIT 9: SEARCH AND RELATED CONTENT
    • Search and related content
      • Exercise 9.1: Explore the default search
      • Exercise 9.2: Set up Job posting content type display in global search
      • Exercise 9.3: Create new search page with Search API
      • Exercise 9.4: Add fields to the index
      • Exercise 9.5: Extend the search with Facets
    • Unit Summary
  • UNIT 10: SITE PERFORMANCE
    • Overview
    • Planning for Peformance
    • Define Goals and Requirements
    • Review current issues and bottlenecks
    • Other performance considerations
    • Unit 10 Summary
    • Glossary of terms
    • Appendices
Powered by GitBook
On this page
  • Providing Feedback
  • Overview and basics
  • Getting started and prerequisites
  • Gitbook & GitHub integration
  • How to contribute
  • Code review process
  • Community

Was this helpful?

Edit on GitHub
Export as PDF

Contributing and Feedback Guide

PreviousGovCMS8 Site Building Training ManualNextSoftware and module requirements

Last updated 2 years ago

Was this helpful?

First of all, thank you for taking the time to provide feedback and/or contribute to the training manuals! We’re continually working on improving these documents with community input and we appreciate any feedback, whether it's helping to contribute to further documentation or code, grammar issues, or simply a suggestion or improvement.

If you want to read the manual you can do so with the following link: .

If you want to contribute and make changes to the manuals, this page will guide you through the contribution process, outlining which tools we use and the steps you need to follow to contribute.

Providing Feedback

There are a few ways you can provide feedback:

  • You can email your feedback to govcms.training@salsadigital.com.au.

  • You can submit an issue via the GitHub issue queue: .

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 Site Building manual is part of the distribution which also includes the .

  • Both these manuals share a which lists out issues and feature requests on a kanban board.

  • to view the current issue queue for the GovCMS content administration manual.

  • All contributions must be licensed under .

Getting started and prerequisites

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

  • Some knowledge of Markdown,

Gitbook & GitHub integration

This repo has two branches:

    • 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.

Code 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

a .

Some basic knowledge of GitHub. Please see to get started.

The following may be helpful.

You can also use a visual WYSIWYG editor for Markdown such as .

master: reserved for production only. The master branch is synced with the and is only editable by maintainers of this repo.

For more information, please see see and if you're not familiar with Pull Requests.

If you have any other questions about contributing to our documentation, please reach out to govcms.training@salsadigital.com.au or join the online .

https://salsa-digital.gitbook.io/govcms-site-builder
https://github.com/govcms-training/site-builder/issues
govcms-training
GovCMS content administration manual
public Roadmap
Click here
CC BY-SA 3.0 AU
GitHub account
Beginner Github guide
Markdown Cheatsheet
Stack Edit
Gitbook page for this manual
Using Pull Request
Fork a Repo
GovCMS Community Discourse