Open mchammer01 opened 1 year ago
This issue has been identified as a small, iterative issue, for which the relevant Docs focus team knows the content to update, as similar issues have been created in the past. As a result, a content design plan may not be needed, and you can proceed with content creation. However, before starting on the content creation, it is your responsibility to check with the PM/stakeholder that we do not need to document anything special, caveats, or edge cases. If that is the case, this work may require a content design plan, and you will need to follow the default workflow. For more information about this automation, and the reasons why we have decided to implement it, see About automations for Dependencies & Secrets in the docs-content repository.
Instructions: Open a PR in docs-internal
and make the changes listed in the relevant collapsible section below. Note that depending on the issue, you may need to create a feature-based versioning flag and use it to version the new content. For more information about these flags, see feature-based versioning.
Thank you :fishsticks: :sparkling_heart:
- If the issue is about a new supported language: - [ ] Update `content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md`. - [ ] Check whether dependency scope is supported by the new language. If it is, update `data/reusables/dependabot/dependabot-alerts-dependency-scope.md` accordingly. - [ ] Update `content/get-started/learning-about-github/github-language-support.md` by referencing a new reusable for the new language (language reusables can be found in `data/reusables/supported-languages`). - [ ] Check whether the headers specified in `data/reusables/supported-languages/products-table-header.md` are correct and still apply. - If the issue is about a new supported package manager or ecosystem: - [ ] Update `data/reusables/dependabot/supported-package-managers.md` by adding a row for the newly supported package manager, and optionally adding a specific section if there are special cases, caveats, or if we need to provide information that does not fit in the table. - [ ] Check whether dependency scope is supported by the new ecosystem. If it is, update `data/reusables/dependabot/dependabot-alerts-dependency-scope.md` accordingly.
- [ ] Update `data/reusables/dependabot/supported-package-managers.md` by adding a row for the newly supported package manager, and optionally adding a specific section if there are special cases, caveats, or if we need to provide information that does not fit in the table. - [ ] Update `content/get-started/learning-about-github/github-language-support.md` by referencing a new reusable for the new language (language reusables can be found in `data/reusables/supported-languages`). - [ ] Get confirmation from the PM/stakeholder about the info that will fill the table columns (YAML value, supported versions, support for private repositories, private registries, and vendoring).
- Update `content/code-security/security-advisories/global-security-advisories/about-the-github-advisory-database.md`.
- Add a new section in the "[Setting up audit log streaming](https://docs.github.com/en/enterprise-cloud@latest/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise#setting-up-audit-log-streaming)" section of "Streaming the audit log for your enterprise."
- Update [{% data reusables.security.compliance-report-list %}](https://github.com/github/docs-internal/blob/main/data/reusables/security/compliance-report-list.md).
Additionally, if this is a Hubber contribution:
ready-for-doc-review
label for a writer review! We need at least 72 business hours to review and finalize your PR, so it’s ready to ship :rocket:
Boing