Skip to content

Commit 884f8f3

Browse files
committed
Set up self-serve API process
1 parent 26daa67 commit 884f8f3

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

documentation/set-up-api-docs.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Update API reference docs
2+
3+
While anyone in the community can propose changes to our API reference docs, the relevant JSON files are built from code in F5 closed source repositories.
4+
5+
Therefore, the audience for this document is limited to F5/NGINX employees.
6+
7+
At this time, the only published and supported API reference docs are available for NGINX One Console, at https://docs.nginx.com/nginx-one/api/api-reference-guide/.
8+
9+
To set up API reference docs for NGINX One Console, follow these steps:
10+
11+
1. Clone the documentation repository, https://github.com/nginx/documentation.
12+
1. Set up Hugo on your system, as described in [Managing content with Hugo](/documentation/writing-hugo.md).
13+
1. Go to the apprpriate internal repository. Create the `one.json` file with the changes that you need.
14+
- Make sure the changes on that `one.json` file are limited to those endpoints that are ready for the public.
15+
1. Set up a branch on your clone of the documentation repository.
16+
1. Copy your one.json file to that branch
17+
- If you're updating the API for NGINX One Console, copy it to the following subdirectory: static/nginx-one/api/.
18+
1. Verify the changes on your local system.
19+
- Build the changes with the `make watch` command as described in [Managing content with Hugo](/documentation/writing-hugo.md).
20+
- Review the result on your system at http://localhost:1313
21+
- For the NGINX One API, the full URL is http://localhost:1313/nginx-one/api/api-reference-guide/
22+
1. To publish this change to the production NGINX documentation repository, push the changes from your branch.
23+
1. Start a pull request on the documentation repository, https://github.com/nginx/documentation.

0 commit comments

Comments
 (0)