Skip to content

Commit

Permalink
More
Browse files Browse the repository at this point in the history
  • Loading branch information
mjang committed Oct 11, 2024
1 parent 824f530 commit 9bfada9
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 4 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
14 changes: 14 additions & 0 deletions F5-NGINX-team-notes.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 9bfada9

Please sign in to comment.