Skip to content

Latest commit

 

History

History
82 lines (52 loc) · 4.15 KB

CONTRIBUTE.md

File metadata and controls

82 lines (52 loc) · 4.15 KB
Raw

Contribute

Hi there! We're thrilled that you'd like to contribute to this landing page repository. Your help is essential for keeping it great.

Creating an issue

If you think of something worth including, improving, or want to contribute, please raise an issue on GitHub.

Submitting a pull request

If you want to contribute to our resources:

  1. Fork or clone the repository
  2. Configure and install the dependencies if you want to run the page in your machine, otherwise none.
  3. Create a new branch: git checkout -b my-branch-name
  4. Make your change
  5. Check how your change looks on our website by hosting the website locally (follow the steps below on how to do this)
  6. Push to your fork and submit a pull request

Your pull request will then be reviewed. You may receive some feedback and suggested changes before it can be approved and your pull request merged.

To increase the likelihood of your pull request being accepted:

  • If you are making visual changes, include a screenshot of what the affected element looks like, both before and after.
  • Follow the style guide.
  • Keep your change as focussed as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write good commit messages.

Contribute to RAP Community of Practice Website

Installing MkDocs

Run the commands (or follow the MkDocs documentation to locally pip install MkDocs):

    # environment.yml

    conda env create -f environment.yml
    conda activate rap-cop-pages

    ---

    # requirements.txt

    ## using pip
    python -m pip install -r requirements.txt

    ## using Conda
    conda create --name <env_name> --file requirements.txt

For best practices on creating virtual environments, please refer to the RAP Community of Practice training resources.

Hosting

To host the website locally to view the live changes, run the command:

    mkdocs serve

Open up http://127.0.0.1:8000/ in your browser, and you'll see the RAP Community of Practice home page being displayed with your updates applied.

Read more: Getting Started with MkDocs

Editing the contents

To add a new file to the repository and website, you can add the file as you would normally and then update 'nav' in mkdocs.yml to include the file within the nested list. Don't forget to check that the links, images, headings, and contents are all working correctly on both the website and in the GitHub repo.

All of the files accessed via the website are nested within the 'docs' folder.

The website currently uses the Material for MkDocs theme. This sets the layout, colour, font, search bar, header, footer, navigation bar and contents. You can follow the documentation to make any changes (e.g. change the colour scheme) as it is simple to use and also easy to overwrite. There is a separate stylesheet, extra.css, which is used to overwrite the colours, fonts and some of the sizing for some elements. Here is a good cheat sheet for what features can be used in MkDocs and also interesting features in Material for MkDocs.

Resources