Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 987 Bytes

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 987 Bytes
Raw

Contributing

Process

Fixing Issues

  1. Open an Issue
  2. Create a PR

New suggestions/report errors

  1. Open an Issue with proposed content
  2. Optional: Come to pig-doc meeting to discuss

Editing

Adding a new page

  • Add a new new_page.md under correct category that your page belongs to (inside of docs/).
  • Update mkdocs.yml's nav key's correct category that your page belongs to.

Publishing a release

  • Merge PR to master
  • Commit directly to master

Preview your changes

Read README.md.

Leveraging mkdocs's --strict flag

mkdocs comes with a --strict flag for building (read: compiling HTML) and serving (read local-dev preview) the documentation.

To leverage the benefits of this flag, one must ensure:

  • All internal references/links are relative.

Hints and callouts

Can be found at https://squidfunk.github.io/mkdocs-material/reference/abbreviations/. (Check left side content-list when accessing the above link).