Create GitLab "new contributor" issues for students

Issue Description

Problem to solve

We're working with a TW training class in the GMT+3 timezone.

We're planning to provide issues to support open source contributions from this class.

The class includes 17 students. We plan to provide two issues / student, which we should add to our list of Good for new contributor issues.

To make sure these issues remain reserved for these students, we'll add a Tichtov-only label

Proposal

Please check your stage groups' open documentation issues and look for at least three issues (per TW, not per group) to apply the label by the due date. Typically, these should not be very large in scope and would not require review by an SME--only a technical writer.

To simplify this process, we will use Vale on existing docs to create these new issues. To do so, take the following steps:

1. Make sure Vale is installed on your system. If you're unsure about the process, ask in the GitLab internal #docs-process room.

2. Run the vale command on the command line. Apply it to a Markdown file with actual content. The output.txt is optional.

   vale path/to/doc.md > output.txt

   If appropriate, separate out the messages. For example, if there are many "errors", you may want to limit the errors that you cite into categories, such as gitlab.Contractions and gitlab.FutureTense.

3. Create a new issue with the errors that you want the students to address.

4. Add the following labels: documentation ~"good for new contributors", Tichtov-only

5. Mark the issue as confidential. If you forget to do so when creating an issue, you can do so after, under the labels:

Proposal

Each TW should create at least three issues using Vale. Typically, these should not be very large in scope and would not require review by an SME--only a technical writer.

Technical Writer

• @aqualls
• @axil
• @eread
• @sselhorn
• @marcel.amirault
• @marcia
• @mjang1
• @msedlakjakubowski
• @ngaskill
• @rdickenson

Further details

Check your user ID when done.

Here's a link to the issues created so far, all in the gitlab-org/gitlab repository.

To create an issue

1. If you haven't already done so, install Vale

2. Run vale on the Markdown file of your choice. For example, to create gitlab#232538 (closed), I ran:

   vale doc/user/group/saml_sso/group_managed_accounts.md

3. Collect / copy the output.

4. Make a judgement on the output. Remove any error/warning messages that require knowledge of the domain or GitLab as a product.

5. Set up a new GitLab issue

6. Include the following sections in the new issue:

   ### Problem to solve
   
   The [Vale linter](https://errata-ai.gitbook.io/vale/) is used to support grammar linting in GitLab documentation. As Vale was implemented after many of the GitLab documents were written, we have many documentation pages that do not meet the linting standards created by the GitLab Technical Writing team for Vale.
   
   ### Further details
   
   As an example, here's the output from a Vale test on the [your_file.md](link to file) file:
   
   <Paste selected output from the vale command>
   
   Each of these messages point to a specific line:column in the noted file. 
   
   ### Proposal
   
   Consider each error message, and see if you can rewrite the noted file with a solution.
   
   ### Who can address the issue
   
   Anyone with an understanding of basic written US English. Ideally, that person should also have
   some domain expertise in the subject area.
   
   ### Additional notes
   
   We appreciate any help that you can provide. If you cannot resolve some of the issues, that is OK, your contributions are still appreciated. And thank you!
   
   

If you want to see the current list of issues created in the GitLab repo, try this link.