From 048687f557fb6bae96eabfb59e086997dc1dfa84 Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Mon, 1 Oct 2018 11:50:32 -0700 Subject: [PATCH 1/5] Update issue templates --- .github/ISSUE_TEMPLATE/add-new-document.md | 14 +++++++++++++ ...uides--type-by-role----for-guides-only-.md | 20 ------------------- .github/ISSUE_TEMPLATE/modify-a-document.md | 19 ++++++++++++++++++ .github/ISSUE_TEMPLATE/modify-document.md | 19 ++++++++++++++++++ .../ISSUE_TEMPLATE/new-document-request.md | 14 +++++++++++++ .github/ISSUE_TEMPLATE/new-document.md | 14 +++++++++++++ 6 files changed, 80 insertions(+), 20 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/add-new-document.md delete mode 100644 .github/ISSUE_TEMPLATE/identify--guides--type-by-role----for-guides-only-.md create mode 100644 .github/ISSUE_TEMPLATE/modify-a-document.md create mode 100644 .github/ISSUE_TEMPLATE/modify-document.md create mode 100644 .github/ISSUE_TEMPLATE/new-document-request.md create mode 100644 .github/ISSUE_TEMPLATE/new-document.md diff --git a/.github/ISSUE_TEMPLATE/add-new-document.md b/.github/ISSUE_TEMPLATE/add-new-document.md new file mode 100644 index 00000000..7c4e4319 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/add-new-document.md @@ -0,0 +1,14 @@ +--- +name: Add new document +about: Request a new document for the Clear Linux* project + +--- + +**Do you think Clear Linux documentation needs new document? Please describe.** +Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. + +**Describe or provide examples of similar documents, if possible, from other web sites** +Please provide an example of similar documents if possible. + +**Additional context** +Add any other context or screenshots for the document request here. diff --git a/.github/ISSUE_TEMPLATE/identify--guides--type-by-role----for-guides-only-.md b/.github/ISSUE_TEMPLATE/identify--guides--type-by-role----for-guides-only-.md deleted file mode 100644 index fb6e16a1..00000000 --- a/.github/ISSUE_TEMPLATE/identify--guides--type-by-role----for-guides-only-.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Identify 'Guides' Type by Role -- For Guides only. -about: For new content in 'Guides', select 1 of 3 categories to which it belongs. - ---- - -New pages will appear here: https://clearlinux.org/documentation/clear-linux/guides - -1. Enter an 'x' in the category for the new "guide": -* [ ] Basics -* [ ] Developer -* [ ] Administrator - -Complete the field below, following the colon, that matches option selected above: - -I am a Clear Linux Beginner (Basics). I want to learn how to: - -I am a Clear Linux Developer. I want to learn how to: - -I am a Clear Linux Administrator. I want to learn how to: diff --git a/.github/ISSUE_TEMPLATE/modify-a-document.md b/.github/ISSUE_TEMPLATE/modify-a-document.md new file mode 100644 index 00000000..48256542 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/modify-a-document.md @@ -0,0 +1,19 @@ +--- +name: Modify a document +about: Modify a document for the Clear Linux* Project + +--- + +**Describe the error/improvement to an existing document or image** +Provide a clear and concise description of the error or proposed improvement. + +**Screenshots** +If applicable, add screenshots to help explain the error or unexpected behavior. + +**Environment (please complete the following information):** + - Clear Linux OS version: [`cat /usr/lib/os-release`] + - Third-party tool/software: [version] + - Command [ [e.g. `sudo -i`] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/modify-document.md b/.github/ISSUE_TEMPLATE/modify-document.md new file mode 100644 index 00000000..b61b9302 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/modify-document.md @@ -0,0 +1,19 @@ +--- +name: Modify document +about: Modify a document for the Clear Linux* Project + +--- + +**Describe the error/improvement to an existing document or image** +Provide a clear and concise description of the error or proposed improvement. + +**Screenshots** +If applicable, add screenshots to help explain the error or unexpected behavior. + +**Environment (please complete the following):** + - Clear Linux OS version: [`cat /usr/lib/os-release`] + - Third-party tool/software: [version] + - Command [ [e.g. `sudo -i`] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/new-document-request.md b/.github/ISSUE_TEMPLATE/new-document-request.md new file mode 100644 index 00000000..739db2ef --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-document-request.md @@ -0,0 +1,14 @@ +--- +name: New document request +about: Request a new document for the Clear Linux* project + +--- + +**Do you think Clear Linux documentation needs new document? Please describe.** +Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. + +**Describe or provide examples of similar documents, if possible, from other web sites** +Please provide an example of similar documents if possible. + +**Additional context** +Add any other context or screenshots for the document request here. diff --git a/.github/ISSUE_TEMPLATE/new-document.md b/.github/ISSUE_TEMPLATE/new-document.md new file mode 100644 index 00000000..01922a0d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new-document.md @@ -0,0 +1,14 @@ +--- +name: New document +about: Request a new document for the Clear Linux* project + +--- + +**Do you think Clear Linux documentation needs a new document? Please describe.** +Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. + +**Describe or provide examples of similar documents, if possible, from other web sites** +Please provide an example of similar documents if possible. + +**Additional context** +Add any other context or screenshots for the document request here. From 39d1f88a04cc0a3e5b537e2238bac5dd9b0ba826 Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Mon, 1 Oct 2018 11:55:37 -0700 Subject: [PATCH 2/5] Omit duplicate. --- .github/ISSUE_TEMPLATE/modify-a-document.md | 19 ------------------- 1 file changed, 19 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/modify-a-document.md diff --git a/.github/ISSUE_TEMPLATE/modify-a-document.md b/.github/ISSUE_TEMPLATE/modify-a-document.md deleted file mode 100644 index 48256542..00000000 --- a/.github/ISSUE_TEMPLATE/modify-a-document.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Modify a document -about: Modify a document for the Clear Linux* Project - ---- - -**Describe the error/improvement to an existing document or image** -Provide a clear and concise description of the error or proposed improvement. - -**Screenshots** -If applicable, add screenshots to help explain the error or unexpected behavior. - -**Environment (please complete the following information):** - - Clear Linux OS version: [`cat /usr/lib/os-release`] - - Third-party tool/software: [version] - - Command [ [e.g. `sudo -i`] - -**Additional context** -Add any other context about the problem here. From 5d499fe7c8d8d0c2177e9934acfbfeca46627a2c Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Mon, 1 Oct 2018 11:56:11 -0700 Subject: [PATCH 3/5] Omit duplicate --- .github/ISSUE_TEMPLATE/new-document-request.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/new-document-request.md diff --git a/.github/ISSUE_TEMPLATE/new-document-request.md b/.github/ISSUE_TEMPLATE/new-document-request.md deleted file mode 100644 index 739db2ef..00000000 --- a/.github/ISSUE_TEMPLATE/new-document-request.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: New document request -about: Request a new document for the Clear Linux* project - ---- - -**Do you think Clear Linux documentation needs new document? Please describe.** -Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. - -**Describe or provide examples of similar documents, if possible, from other web sites** -Please provide an example of similar documents if possible. - -**Additional context** -Add any other context or screenshots for the document request here. From cdce8905b83ca22d630e19d4c43c229b2b597e43 Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Mon, 1 Oct 2018 11:56:33 -0700 Subject: [PATCH 4/5] Omit duplicate --- .github/ISSUE_TEMPLATE/add-new-document.md | 14 -------------- 1 file changed, 14 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/add-new-document.md diff --git a/.github/ISSUE_TEMPLATE/add-new-document.md b/.github/ISSUE_TEMPLATE/add-new-document.md deleted file mode 100644 index 7c4e4319..00000000 --- a/.github/ISSUE_TEMPLATE/add-new-document.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Add new document -about: Request a new document for the Clear Linux* project - ---- - -**Do you think Clear Linux documentation needs new document? Please describe.** -Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. - -**Describe or provide examples of similar documents, if possible, from other web sites** -Please provide an example of similar documents if possible. - -**Additional context** -Add any other context or screenshots for the document request here. From d419b0ba3b01ea287a963dcdf846e281f3aaae9c Mon Sep 17 00:00:00 2001 From: michael vincerra <37549381+mvincerx@users.noreply.github.com> Date: Mon, 1 Oct 2018 16:39:11 -0700 Subject: [PATCH 5/5] Update new-document.md --- .github/ISSUE_TEMPLATE/new-document.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/new-document.md b/.github/ISSUE_TEMPLATE/new-document.md index 01922a0d..cf63a349 100644 --- a/.github/ISSUE_TEMPLATE/new-document.md +++ b/.github/ISSUE_TEMPLATE/new-document.md @@ -7,6 +7,9 @@ about: Request a new document for the Clear Linux* project **Do you think Clear Linux documentation needs a new document? Please describe.** Please provide a clear and concise description of the title and content. Identify the target audience: Developer; System Administrator; or Basic User. +**Should the new document be a guide, a reference, or a tutorial?** +Recommend a type of document, based on the structure here: https://clearlinux.org/documentation/clear-linux + **Describe or provide examples of similar documents, if possible, from other web sites** Please provide an example of similar documents if possible.