Skip to content
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

feat: Update closed contribution documentation with new branch #330

Merged
merged 2 commits into from
Mar 31, 2025

Conversation

ADubhlaoich
Copy link
Contributor

Proposed changes

Thanks to some follow up work by @eepifanova, we can now target the main branch for closed content work. This commit updates the documentation to reference the main branch, and also adds specificity of origin and remote when referencing it for clarity.

It also adds missing punctuation, and adjusts spacing in an early paragraph using a line break.

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 requested a review from a team as a code owner March 28, 2025 16:16
@github-actions github-actions bot added the process documentation Documentation related to how the repository or documention itself is managed. label Mar 28, 2025
Thanks to some follow up work by @eepifanova, we can now target the main
branch for closed content work. This commit updates the documentation to
reference the main branch, and also adds specificity of origin and
remote when referencing it for clarity.

It also adds missing punctuation, and adjusts spacing in an early
paragraph using a line break.
@ADubhlaoich ADubhlaoich force-pushed the docs/change-closed-target branch from c5397bc to d7dc116 Compare March 28, 2025 16:17
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) March 28, 2025 16:18
Copy link

Deploy Preview will be available once build job completes!

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

@eepifanova
Copy link
Contributor

@ADubhlaoich it will be available soon, I'll tell you :)

@@ -53,7 +55,7 @@ Open a pull request when you are ready to receive feedback from stakeholders.

After any iterative work, close the pull request. Since the closed repository is a mirror of the open one, we do not merge changes to it.

Change back to `main`, create a new branch, merge your internal branch and push to origin.
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line confused me until I realized it's an overview of the commands which follow. So maybe:

Suggested change
Change back to the origin `main` branch, create a new branch, merge your internal branch and push to origin.
With the following commands, check out the `main` branch, create a new branch, merge your internal branch, and push the changes to origin.

Copy link
Contributor Author

@ADubhlaoich ADubhlaoich Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm confused what the value add in your edit suggestion is: the sentence is an imperative instruction telling you exactly what to do, then showing you how to do it.

In context, the instruction is juxtaposed with the exact commands to follow in the code block immediately afterwards, and there is only one thing you could possibly be pushing, so all this seems to do is add unnecessary words.

Copy link
Contributor

@mjang mjang Mar 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternative is to be more precise with the commands, something like:

git checkout main
git checkout -b desired-branch-name
git merge internal/other-branch-name
git push origin main

In any case, based on @eepifanova 's suggestion in Slack, this might all become moot.

@ADubhlaoich ADubhlaoich disabled auto-merge March 28, 2025 17:27
@eepifanova
Copy link
Contributor

@ADubhlaoich
I confirm using nginx/internal-docs@main as a source branch for all works on documentation.
The @main branch is the default one - so it's easy and convenient to make new branches in internal-docs
The @main branch is full clone of nginx/documentation@main

Feel free to update documentation ^^

@ADubhlaoich ADubhlaoich merged commit 765f212 into main Mar 31, 2025
9 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/change-closed-target branch March 31, 2025 10:06
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.

4 participants