Skip to content

feat: Update closed documentation process #323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 27, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Mar 27, 2025

Proposed changes

This pull request updates the closed documentation contribution process by fixing the remote git command, and grouping the relevant a user would likely do in quick succession.

It also rephrases it on the premise that the user likely already has the main repository cloned, so gives and frames adding the remote as an earlier step in the process overall.

The process itself was used to make this pull request!

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

@ADubhlaoich ADubhlaoich self-assigned this Mar 27, 2025
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner March 27, 2025 16:36
@github-actions github-actions bot added the process documentation Documentation related to how the repository or documention itself is managed. label Mar 27, 2025
Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/323/

@ADubhlaoich ADubhlaoich enabled auto-merge (squash) March 27, 2025 16:41
@ADubhlaoich ADubhlaoich disabled auto-merge March 27, 2025 16:54
@ADubhlaoich ADubhlaoich merged commit 6b01ab0 into main Mar 27, 2025
9 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-closed-process branch March 27, 2025 16:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
process documentation Documentation related to how the repository or documention itself is managed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants