Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,15 @@ npm run build # production build
npm run check # typecheck + build
npm run test:smoke # smoke tests
```

## Good Docs Project Templates

The Good Docs Project template bundle is stored at:

`meta/reference/good-docs-project-template-1.5.0/`

Use these files as read-only reference material when planning documentation information architecture, page types, explanation flow, templates, and writing patterns.

Do not edit, rewrite, reformat, rename, delete, or regenerate files under `meta/reference/good-docs-project-template-1.5.0/` unless the user explicitly asks to update the vendored template bundle itself.

When applying recommendations from the templates, make changes in the Promptless documentation source files instead, such as files under `src/content/docs/`.
7 changes: 7 additions & 0 deletions meta/reference/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Agent Instructions for Reference Material

This directory contains reference material for humans and agents.

Files in this directory are not website source content and are not generated output. Treat third-party reference bundles here as immutable inputs.

The Good Docs Project template bundle at `good-docs-project-template-1.5.0/` is read-only. You may inspect and cite it when making documentation recommendations, but do not edit files in that directory unless the user explicitly asks to update the vendored template bundle itself.
11 changes: 11 additions & 0 deletions meta/reference/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Reference Material

This directory contains source and reference material that can inform documentation strategy, information architecture, and writing patterns.

## Good Docs Project template 1.5.0

`good-docs-project-template-1.5.0/` contains the downloaded Good Docs Project template bundle.

Use it as a reference for documentation page types such as concept docs, quickstarts, how-to guides, tutorials, reference docs, troubleshooting docs, release notes, changelogs, glossaries, and style guides.

Do not edit the template bundle as part of normal Promptless documentation changes. Apply useful patterns from the templates to the Promptless docs source files instead.
13 changes: 13 additions & 0 deletions meta/reference/good-docs-project-template-1.5.0/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.

# Misc
.vscode
.DS_Store
*.pem

# Local env files
.env
.env.local
.env.development.local
.env.test.local
.env.production.local
16 changes: 16 additions & 0 deletions meta/reference/good-docs-project-template-1.5.0/.gitlab-ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
stages:
- ekline-pr-review

ekline-pr-review-job:
stage: ekline-pr-review
image: ghcr.io/ekline-io/ekline-ci-cd:v6
rules:
- if: '$CI_PIPELINE_SOURCE == "merge_request_event" && $CI_MERGE_REQUEST_LABELS =~ /ekline/i'
script:
- echo "Running EkLine"
variables:
INPUT_EK_TOKEN: $EK_TOKEN
INPUT_GITLAB_TOKEN: $GITLAB_API_TOKEN
INPUT_REPORTER: 'gitlab-mr-discussion'
# INPUT_FILTER_MODE: 'added'
# INPUT_IGNORE_RULE: "EK00001,EK00004" # Optional
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
The [{content type} template](link-to-file) is missing the following template file deliverables:

* [ ] **Template resources** - Includes the resources consulted during the research phase of creating the template. Also includes high quality examples of that content type that served as inspiration for the template.
* [ ] **Template process** - Explains best practices for researching, writing, and maintaining this content type.

Templateers who work on this issue will need to create these template file deliverables. See the [Template deliverables guide](https://gitlab.com/tgdp/templates/-/blob/main/template-deliverables.md) for guidance about these files. You can also look at examples of other templates in the repository to see examples of each template file. Be aware that some templates might be missing some files.

## Link to Google Doc drafts
Our project composes rough draft of templates in Google Docs that are owned and maintained by the project leads. The Good Docs Project owns these files so that we can maintain our project archive and history. With that in mind, the project has pre-generated Google Doc files for you to use as you are researching and drafting your template project. These files include a starting point for the structure of each file that should help you as you draft the documents:

* [ ] **Template resources** - [{Content type} resources](link-to-Google-Doc)
* [ ] **Template process** - [{Content type} process](link-to-Google-Doc)

Bookmark these drafts and use them as you work on your project.

See the next section for more information about these files.

## Definition of done
A template project is considered complete when the missing template file deliverables have been added to the template.

### Template writing phases
Although it is optional, we recommend working these missing files through each template writing phase.

See the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md) for guidance about these phases. You can also receive help from your working group leads and members about how to move your issue through each phase.

### Required template deliverables
To be considered complete, a template project must have the missing files.

## Want to work on this template?
Great! Make sure you follow our contributing guidelines:

1. Check that the template is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer.
2. Join The Good Docs Project by attending a [Welcome Wagon meeting](https://thegooddocsproject.dev/welcome/). You will get access to The Good Docs Project Slack workspace after scheduling or attending this meeting.
3. Read the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md).
4. You are strongly encouraged to join one of the [working groups](https://thegooddocsproject.dev/working-group/) to get valuable support from the community such as mentorship, Git training, and helpful feedback as you contribute to your first template.
5. Request access to the `templates` repository by joining the #tech-requests channel in Slack and posting a request.
6. [Assign yourself to an issue](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#assignee) for the template that you want to work on.
7. Add the `Template phase:: Research` label to the issue.
8. Attend your template working group regularly to receive support and resources for your project.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
{Add a description of the template pack, use case, and intended audience.}

See [Template packs](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md#template-packs) for more information about what a template pack is.

## Templates that are planned for this template pack
The following templates are planned for this template pack:

* [ ] {Template name} - {issue link}
* [ ] {Template name} - {issue link}
* [ ] {Template name} - {issue link}
* [ ] {Template name} - {issue link}
* [ ] {Template name} - {issue link}

## Definition of done
A template pack can be released as soon as it has at least at least one of each template that is:

* Task-oriented
* Concept-oriented
* Reference-oriented

The template pack can be released if it has one of each of these types of templates, but the issue can't be closed until all planned templates are complete.

A template pack is released when it is included on our README file or our website. All new or enhanced template packs should be included in the release notes.

## Want to work on this template pack?
Great! The best way to contribute is to work on one of the templates that are part of the pack. See the issue for that specific template for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{Add a description of the tactic article topic.}

{Optional: List any resources the templateer might consult while creating the article.}

See [The Good Docs Project tactic articles](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md#the-good-docs-project-tactic-articles) for more information about what a tactic article is.

## Definition of done
Tactic articles are written using the same processes, workflows, and teams as a template project. However, they are published on the website instead of in the template repository.

A tactic article template project is considered complete when it has progressed through all the template writing phases and when it has been merged into the website.

### Tactic article writing phases
To be considered complete, a tactic article must progress through each template writing phase:

* [ ] **Research phase** - When you first start a tactic article, you begin by researching examples and best practices for that article. This phase ends when you create your *resources* document for that article.
* [ ] **Rough draft phase** - After you conclude your research, you create a draft of your tactic article in Google Docs. This phase ends when you schedule your drafts for review by other members of your working group or community.
* [ ] **Community review phase** - When your tactic article is ready for review, your working group lead will schedule 1-2 sessions in the community where other members of the project will review and provide feedback on your template files deliverables. This phase ends after you incorporate the feedback into your draft and your drafts are in a final state.
* [ ] **Editorial review phase** - When your draft is in a state where you feel it is ready to get merged in, you can work with your working group lead to request an editorial team review. The template editorial team is composed of experienced members of the project who review your template project to ensure that it follows best practices for technical writing, has no major organization or structural issues, has no obvious gaps or missing content, is consistent with our style guide.
* [ ] **Final review phase** - When your tactic article is in a final state, you convert it from Google Docs into Markdown and [open a merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) to add your template to the website repository. The template leads will review the template and possibly request additional changes. This phase ends when the article is merged into the repository.

See the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md) for guidance about these phases. You can also receive help from your working group leads and members about how to move your template project through each phase.

## Want to work on this tactic article?
Great! Make sure you follow our contributing guidelines:

1. Check that the article is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer.
2. Join The Good Docs Project by attending a [Welcome Wagon meeting](https://thegooddocsproject.dev/welcome/). You will get access to The Good Docs Project Slack workspace after scheduling or attending this meeting.
3. Read the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md).
4. You are strongly encouraged to join one of the [working groups](https://thegooddocsproject.dev/working-group/) to get valuable support from the community such as mentorship, Git training, and helpful feedback as you contribute to your first template.
5. Request access to the `templates` and `website` repository by joining the #tech-requests channel in Slack and posting a request.
6. [Assign yourself to an issue](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#assignee) for the article that you want to work on.
7. Add the `Template phase:: Research` label to the issue.
8. Attend your template working group regularly to receive support and resources for your project.
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
{Add a description of the template content type.}

{Optional: List any resources the templateer might consult while creating the template.}

## Link to Google Doc drafts
Our project composes rough draft of templates in Google Docs that are owned and maintained by the project leads. The Good Docs Project owns these files so that we can maintain our project archive and history. With that in mind, the project has pre-generated Google Doc files for you to use as you are researching and drafting your template project. These files include a starting point for the structure of each file that should help you as you draft the documents:

* [ ] **Template file** - [{Content type} file](link-to-Google-Doc)
* [ ] **Template guide** - [{Content type} guide](link-to-Google-Doc)
* [ ] **Template resources** - [{Content type} resources](link-to-Google-Doc)
* [ ] **Template process** - [{Content type} process](link-to-Google-Doc)

Bookmark these drafts and use them as you work on your project.

See the next section for more information about these files.

## Definition of done
A template project is considered complete when it has progressed through all the template writing phases and when it has all the required template file deliverables.

### Template writing phases
To be considered complete, a template project must progress through each template writing phase:

* [ ] **Research phase** - When you first start a template project, you begin by researching examples and best practices for that template project. This phase ends when you create your *resources* document for that template.
* [ ] **Rough draft phase** - After you conclude your research, you create drafts of your template file deliverables in Google Docs. This phase ends when you schedule your drafts for review by other members of your working group or community.
* [ ] **Community review phase** - When your template project is ready for review, your working group lead will schedule 1-2 sessions in the community where other members of the project will review and provide feedback on your template files deliverables. This phase ends after you incorporate the feedback into your draft and your drafts are in a final state.
* [ ] **Editorial review phase** - When your draft is in a state where you feel it is ready to get merged in, you can work with your working group lead to request an editorial team review. The template editorial team is composed of experienced members of the project who review your template project to ensure that it follows best practices for technical writing, has no major organization or structural issues, has no obvious gaps or missing content, is consistent with our style guide.
* [ ] **Final review phase** - When your template is in a final state, you convert it from Google Docs into Markdown and [open a merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html) to add your template to the templates repository. The template leads will review the template and possibly request additional changes. This phase ends when the template is merged into the repository.

After the final review phase, the template project is considered done. However, be aware that after it is merged, the template then goes to the Chronologue working group for testing. They will make a high quality example of the template and they may make additional changes to the template to improve its usability.

See the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md) for guidance about these phases. You can also receive help from your working group leads and members about how to move your template project through each phase.

### Required template deliverables
To be considered complete, a template project must have the following four files:

* [ ] **Template file** - The raw template for the content type.
* [ ] **Template guide** - Provides a deeper explanation of how to fill in the template.
* [ ] **Template resources** - Includes the resources consulted during the research phase of creating the template. Also includes high quality examples of that content type that served as inspiration for the template.
* [ ] **Template process** - Explains best practices for researching, writing, and maintaining this content type.

After a template project is complete, our Chronologue working group will create an example of the template.

See the [Template deliverables guide](https://gitlab.com/tgdp/templates/-/blob/main/template-deliverables.md) for guidance about these files. You can also look at examples of other templates in the repository to see examples of each template file. Be aware that some templates might be missing some files.

## Want to work on this template?
Great! Make sure you follow our contributing guidelines:

1. Check that the template is unassigned. If it is assigned, you might be able to work with the current assignee as a paired writer.
2. Join The Good Docs Project by attending a [Welcome Wagon meeting](https://thegooddocsproject.dev/welcome/). You will get access to The Good Docs Project Slack workspace after scheduling or attending this meeting.
3. Read the [Templates CONTRIBUTING guide](https://gitlab.com/tgdp/templates/-/blob/main/CONTRIBUTING.md).
4. You are strongly encouraged to join one of the [working groups](https://thegooddocsproject.dev/working-group/) to get valuable support from the community such as mentorship, Git training, and helpful feedback as you contribute to your first template.
5. Request access to the `templates` repository by joining the #tech-requests channel in Slack and posting a request.
6. [Assign yourself to an issue](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#assignee) for the template that you want to work on.
7. Add the `Template phase:: Research` label to the issue.
8. Attend your template working group regularly to receive support and resources for your project.
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Merge request summary

{Describe the purpose of your merge request. For example: "Adds the abc template to the repository."}

IMPORTANT: The next three sections in this checklist should be filled out by the template contributor at the time they submit this request. Merge requests can only be merged when all boxes are checked.

## Which issue does this merge request fix or reference?

This merge request:

* Resolves: {#issue-number} {Choose this option if this MR will close the issue and link to issue}
* Relates to: {#issue-number} {Choose this option if this MR only references an issue for context but does not fully resolve it}

## Working group and contributor details

* **Additional template contributors:** {If you did not author the template alone, list the names of your fellow contributors here and assign them to this merge request}
* **Template working group:** {Delete any that don't apply:} Team Alpaca / Team Dolphin / Team Macaw
* **Template working group lead(s):** {List name of working group lead(s) that approved this template project to move to the merge request phase}

By checking this box, I certify that:

* [ ] My template project received one or more community review and was approved by my working group lead(s) to move to the next phase.
* [ ] My template project received one or more editorial review by the template editorial team and was approved by my working group lead(s) to move to the next phase.
* [ ] My template was approved by my working group lead(s) to move to the merge request phase.

## Template deliverables requirements

By checking this box, I certify that:

* [ ] Template file is present.
* [ ] Template guide is present.
* [ ] Template resources is present.
* [ ] Template process is present.

## Checklist for reviewers

IMPORTANT: The rest of this checklist should only be filled out by authorized Good Docs Project template maintainers with merge rights. If you are the individual template contributor, do not fill out the rest of the fields or check the boxes.

NOTE: Merge requests can only be merged when all boxes are checked.

* [ ] Verify that all required files are present.
* [ ] Verify that this template project received all required reviews.
* [ ] Verify Markdown renders correctly.
* [ ] Verify the raw Markdown to ensure it is well-formed and follows best practices.
* [ ] Verify the files are free from grammar errors and typos.
Loading