From f2bb6652f6385187da665225c9604f1931cef241 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Mon, 18 Nov 2019 13:42:46 -0400 Subject: [PATCH 1/4] Delete docs_style_guide.md Removing style guide from tech docs to put it in contributing docs --- docs/technical-documentation/docs_style_guide.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 docs/technical-documentation/docs_style_guide.md diff --git a/docs/technical-documentation/docs_style_guide.md b/docs/technical-documentation/docs_style_guide.md deleted file mode 100644 index 7106deda9..000000000 --- a/docs/technical-documentation/docs_style_guide.md +++ /dev/null @@ -1,14 +0,0 @@ -# Documentation Style Guide - -## Do's - -- Submit documentation formatted in [Markdown](https://en.wikipedia.org/wiki/Markdown) format. - -- Please add Markdown headings to the content sections. -- Use a GitHub Pull Request to submit documentation. -- Use the "bold/emphasis" style in Markdown for UI elements that users will interact with. For example, a button label for a button that must be pressed should be made bold in Markdown. -- Use the "italics" style in Markdown for UI elements that have a label or title if you need to reference them in the documentation. For example, a title of a screen or page that will visit should be made italic in Markdown. - -## Don'ts - -- Do not leave any "trailing spaces" at the end of lines of content. -- Do not use "curly" quotes and apostrophes, use only "straight" quotes and apostrophes. From 944adf3c8ec1c2fda618d67a523f83c2d93365a8 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Mon, 18 Nov 2019 13:49:59 -0400 Subject: [PATCH 2/4] Create docs_style_guide.md Updates to the style guide --- docs/contributing/docs_style_guide.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/contributing/docs_style_guide.md diff --git a/docs/contributing/docs_style_guide.md b/docs/contributing/docs_style_guide.md new file mode 100644 index 000000000..029810f49 --- /dev/null +++ b/docs/contributing/docs_style_guide.md @@ -0,0 +1,21 @@ +# Documentation Style Guide + +## Do's + +- Submit documentation formatted in [Markdown](https://en.wikipedia.org/wiki/Markdown) format. + -- Please add Markdown headings to the content sections. +- Use a GitHub Pull Request to submit documentation. +- Use the "bold/emphasis" style in Markdown for UI elements that users will interact with. For example, a button label for a button that must be pressed should be made bold in Markdown. +- Use the "italics" style in Markdown for UI elements that have a label or title if you need to reference them in the documentation. For example, a title of a screen or page that will visit should be made italic in Markdown. +- Use `-` instead of `*` for bulleted lists. +- Upload images to the 'assets' folder and reference them from there. + -- For file name, use underscores between words and prefix all file names with the page name, e.g. context_display_hints.jpg for the image showing how to set display hints in the context menu. +- Use `!!! note` at the start of a paragraph to have it rendered as a note like this: + +!!! note I am a helpful tip! + +## Don'ts + +- Do not leave any "trailing spaces" at the end of lines of content. +- Do not use "curly" quotes and apostrophes, use only "straight" quotes and apostrophes. +- Do not upload images that are excessively large in file size (remember, these docs are part of the software!) From 0185dc6597f9aea97aa1dbc86ff5a80dc2c4a502 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Tue, 19 Nov 2019 14:36:30 -0400 Subject: [PATCH 3/4] Update mkdocs.yml --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 7d1374b6f..c78ab2dce 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,7 +66,6 @@ pages: - 'Flysystem': 'technical-documentation/flysystem.md' - 'JWT Authentication': 'technical-documentation/jwt.md' - 'Versioning Policy': 'technical-documentation/versioning.md' - - 'Documentation Style Guide': 'technical-documentation/docs_style_guide.md' - 'How to Build Documentation': 'technical-documentation/docs-build.md' - 'Testing Notes': 'technical-documentation/testing-notes.md' - 'Adding back ?_format=jsonld': 'technical-documentation/adding_format_jsonld.md' @@ -77,4 +76,5 @@ pages: - 'Islandora 7': 'technical-documentation/migrate-7x.md' - Contributing: - 'How to contribute': 'contributing/CONTRIBUTING.md' + - 'Documentation Style Guide': 'technical-documentation/docs_style_guide.md' - 'Committers': 'contributing/committers.md' From 8986a2413a970f7b56f313d7bae2883b91998707 Mon Sep 17 00:00:00 2001 From: Melissa Anez Date: Tue, 19 Nov 2019 14:48:20 -0400 Subject: [PATCH 4/4] Update mkdocs.yml MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🤦‍♀ --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index c78ab2dce..88fdf3c25 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -76,5 +76,5 @@ pages: - 'Islandora 7': 'technical-documentation/migrate-7x.md' - Contributing: - 'How to contribute': 'contributing/CONTRIBUTING.md' - - 'Documentation Style Guide': 'technical-documentation/docs_style_guide.md' + - 'Documentation Style Guide': 'contributing/docs_style_guide.md' - 'Committers': 'contributing/committers.md'