generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 90
feat: Move and update process documentation #717
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
Open
ADubhlaoich
wants to merge
3
commits into
main
Choose a base branch
from
docs/update-process-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
CLOSED_CONTRIBUTIONS.md → documentation/closed-contributions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
21 changes: 9 additions & 12 deletions
21
F5-NGINX-team-notes.md → documentation/maintainers-etiquette.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,24 +1,21 @@ | ||
# For F5/NGINX Employees | ||
# Maintainers etiquette | ||
|
||
This repository is public, and we do as much of our work as possible in the public as a commitment to open source. | ||
|
||
Before new content is published at https://docs.nginx.com, it must be committed to this `documentation` repository. | ||
|
||
If you are an F5 employee unable to assign yourself as an owner of an issue or a reviewer of a pull request, ask a member of the NGINX documentation team for help. | ||
|
||
If your content cannot be publicized before release, it is handled differently: read the [Contributing guidelines for closed content](/CLOSED_CONTRIBUTIONS.md) document. | ||
This document is intended for the maintainers of the repository, who are any F5/NGINX employees that contribute to it. | ||
|
||
We encourage you to work with community contributors. If you participate in PRs, issues, discussions, and more, follow these guidelines: | ||
|
||
- Follow the [Code of Conduct](./CODE_OF_CONDUCT.md). | ||
- Be helpful. We want to encourage people who contribute to continue. | ||
- If you need to say "no," here's [an example](https://github.com/nginx/documentation/pull/307#issuecomment-2748521932) of how we interact with the community. | ||
- If you need to say "no," here's [an example](https://github.com/nginx/documentation/pull/307#issuecomment-2748521932) of how to interact with the community. | ||
- Avoid references and links to internal content. | ||
- Do not include information about future releases, changes, or features, unless | ||
specifically authorized. | ||
- Do not include anything that even resembles PII. | ||
- Do not include information about future releases, changes, or features, unless specifically authorized. | ||
- Do not include anything that resembles PII. | ||
- Do not include information that is proprietary to and/or private within F5/NGINX. | ||
|
||
This repository is public, and we do as much of our work as possible in the public as a commitment to open source. | ||
|
||
As an F5/NGINX employee, if you have a GitHub account, you should be able to clone these repositories. | ||
|
||
If your content cannot be visible before release, you should read the [Contributing guidelines for closed content](/CLOSED_CONTRIBUTIONS.md) document. | ||
|
||
To protect F5/NGINX, the ability to merge pull requests is strictly limited to employees of F5/NGINX. |
File renamed without changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we squash and merge I think this guideline is somewhat moot, but partially why conventional commits are important. I have stronger opinions about this and would like the git style guide to be its own document, but it will be its own PR.