From 9bfada9f1f76404cbc97b4bac9d1e92dd21f3c01 Mon Sep 17 00:00:00 2001 From: Mike Jang Date: Fri, 11 Oct 2024 12:39:29 -0700 Subject: [PATCH] More --- CONTRIBUTING.md | 8 +++++--- CONTRIBUTING_DOCS.md | 2 +- F5-NGINX-team-notes.md | 14 ++++++++++++++ 3 files changed, 20 insertions(+), 4 deletions(-) create mode 100644 F5-NGINX-team-notes.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cb92f29ae..c06916448 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,9 @@ # Contributing guidelines -The following is a set of guidelines for contributing to this project. -We really appreciate your desire to contribute! +The following is a set of guidelines for community contributions to this +project. We really appreciate your desire to contribute! + +If you are an F5/NGINX employee, see the following guidance [For F5/NGINX Employees](./F5-NGINX-team-notes.md). ## Table of contents @@ -35,7 +37,7 @@ we encourage you to use ## Submit a Pull Request -To contribute to NGINX documentation, follow these steps: +To contribute to F5 NGINX documentation, follow these steps: - Fork the NGINX repository - Create a branch diff --git a/CONTRIBUTING_DOCS.md b/CONTRIBUTING_DOCS.md index dfa31abf5..bba4e8394 100644 --- a/CONTRIBUTING_DOCS.md +++ b/CONTRIBUTING_DOCS.md @@ -22,7 +22,7 @@ When you set up an image, this is the standard format: {{< img src="path/to/images/file-name.png" alt="descriptive text for screenreaders" >}} -You'll find images in the [static](../static) subdirectory, in a directory assocaited with the documentation. For example, if you've set up the `file-name.png` +You'll find images in the [static](../static) subdirectory, in a directory associated with the documentation. For example, if you've set up the `file-name.png` image, you should copy that file to the `static/path/to/images` directory. ## Build documentation locally diff --git a/F5-NGINX-team-notes.md b/F5-NGINX-team-notes.md new file mode 100644 index 000000000..3f184a46f --- /dev/null +++ b/F5-NGINX-team-notes.md @@ -0,0 +1,14 @@ +# For F5/NGINX Employees + +This repository is a functional mirror. If you want to make a change to F5/NGINX +documentation, use the private source repository. + +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. +- Avoid references and links to internal content. +- Do not include information about future releases, changes, or features, unless + specifically authorized. +- Do not include information that is proprietary to and/or private within F5/NGINX. \ No newline at end of file