Skip to content

Commit 2f9809e

Browse files
authored
feat: Add deprecated content process documentation (#1401)
This commit adds a process document for reviewing old, deprecated content. This was always possible thanks to git revision history, but there was no single reference point available for when deprecated content was removed. This new process document is a quick reference point, allowing someone to check out the relevant state of documentation for a given product without needing to undergo any git archaeology.
1 parent aa50450 commit 2f9809e

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

documentation/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ If you're interested in contributing to the [NGINX documentation website](https:
1818
- [Managing content with Hugo](/documentation/hugo-content.md)
1919
- [Using include files](/documentation/include-files.md)
2020
- [Contributing closed content](/documentation/closed-contributions.md)
21+
- [Review deprecated content](/documentation/deprecated-content.md)
2122

2223
## Writing guidance
2324

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Review deprecated content
2+
3+
As part of the documentation lifecycle, the documentation team periodically removes deprecated content.
4+
5+
Although a product may no longer be available for sale, we maintain the documentation until end of support for the benefit of its users.
6+
7+
By removing the content, their files do not create unnecessary noise when working on documentation, nor impact the user search experience.
8+
9+
Since we use git to track file changes, the documentation is still available by checking out an older revision of the repository.
10+
11+
To quickly traverse git history, we have created tags corresponding to the last commit prior to the removal of the products' files.
12+
13+
## Check out deprecated product documentation
14+
15+
To check out deprecated product documentation, use the `git` command:
16+
17+
```shell
18+
git checkout <product-tag>
19+
```
20+
21+
You should replace `<product-tag>` with a tag from the following table:
22+
23+
| Product name | Tag | Date of removal |
24+
| -------------------------------------- | -------------------- | --------------- |
25+
| NGINX App Protect WAF[^1] | `archive-nap` | 2025-11-05 |
26+
| NGINX Controller | `archive-controller` | 2025-10-08 |
27+
| NGINX Management Suite[^2] | `archive-nms` | 2025-10-08 |
28+
| NGINX Service Mesh | `archive-mesh` | 2025-11-05 |
29+
30+
## Review and add tags
31+
32+
You can review the repository tags using the `git tag` command:
33+
34+
```text
35+
➜ git tag -l
36+
archive-controller
37+
archive-mesh
38+
archive-nap
39+
archive-nms
40+
```
41+
42+
To add a new tag, use the following command:
43+
44+
```shell
45+
git tag -a <tag-name> <commit-sha>
46+
```
47+
48+
The tag name should follow the format of _archive-\<product-name\>_, and the commit sha should be the last commit **before** the content was removed.
49+
50+
To add the new tag to the remote repository, you must add it as an explicit argument to `git push`:
51+
52+
```shell
53+
git push origin <tag-name>
54+
```
55+
56+
[^1]: NGINX App Protect WAF is now known as F5 WAF for NGINX
57+
[^2]: NGINX Management Suite was refactored into NGINX Instance Manager

0 commit comments

Comments
 (0)