Skip to content

Commit 121a33a

Browse files
authored
Process: Updates for moving docs content to web-unified-docs repo. (#27097)
* Updates for moving docs content to web-unified-docs repo. * Tim's feedback: update contributing/checklists * add to tag nomad-docs for help
1 parent ac19c78 commit 121a33a

File tree

8 files changed

+59
-40
lines changed

8 files changed

+59
-40
lines changed

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,12 @@
33

44
blank_issues_enabled: false
55
contact_links:
6+
- name: Create a documentation issue
7+
url: https://github.com/hashicorp/web-unified-docs/issues
8+
about: Create a Nomad documentation bug or content request in the web-unified-docs repository.
69
- name: Ask a Question
710
url: https://discuss.hashicorp.com/c/nomad
811
about: If you have a question, or are looking for advice, please post on our Discuss forum.
9-
- name: Nomad Learn Tracks
10-
url: https://learn.hashicorp.com/nomad
11-
about: Please check out our Learn Guides. These hands on guides deal with many of the tasks common to using Nomad.
12+
- name: Nomad Tutorials
13+
url: https://developer.hashicorp.com/nomad/tutorials
14+
about: Please check out our tutorials. These tutorials provide in-depth learning on Nomad features.

.github/pull_request_template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,14 @@ merged.
2121
- [ ] **Testing** Please add tests to cover any new functionality or to demonstrate bug fixes and
2222
ensure regressions will be caught.
2323
- [ ] **Documentation** If the change impacts user-facing functionality such as the CLI, API, UI,
24-
and job configuration, please update the Nomad website documentation to reflect this. Refer to
25-
the [website README](../website/README.md) for docs guidelines. Please also consider whether the
26-
change requires notes within the [upgrade guide](../website/content/docs/upgrade/upgrade-specific.mdx).
24+
and job configuration, please update the Nomad product documentation, which is
25+
stored in the [`web-unified-docs` repo](https://github.com/hashicorp/web-unified-docs/). Refer to
26+
the [`web-unified-docs` contributor
27+
guide](https://github.com/hashicorp/web-unified-docs/docs/contribute.md) for
28+
docs guidelines. Please also consider whether the
29+
change requires notes within the [upgrade
30+
guide](https://developer.hashicorp.com/nomad/docs/upgrade/upgrade-specific).
31+
If you would like help with the docs, tag the `nomad-docs` team in this PR.
2732

2833
### Reviewer Checklist
2934
- [ ] **Backport Labels** Please add the correct backport labels as described by the internal

CODEOWNERS

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,3 @@
55

66
# codeowner default
77
* @hashicorp/github-nomad-core @hashicorp/nomad-eng
8-
9-
10-
# engineering and web presence get notified of, and can approve changes to web tooling, but not content.
11-
12-
/website/ @hashicorp/web-devdot @hashicorp/github-nomad-core @hashicorp/nomad-eng
13-
/website/data/
14-
/website/public/
15-
/website/content/
16-
17-
# education and engineering get notified of, and can approve changes to web content.
18-
19-
/website/data/ @hashicorp/nomad-docs @hashicorp/github-nomad-core @hashicorp/nomad-eng
20-
/website/public/ @hashicorp/nomad-docs @hashicorp/github-nomad-core @hashicorp/nomad-eng
21-
/website/content/ @hashicorp/nomad-docs @hashicorp/github-nomad-core @hashicorp/nomad-eng

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ Nomad is a simple and flexible workload orchestrator to deploy and manage contai
1313

1414
Nomad is supported on Linux, Windows, and macOS. A commercial version of Nomad, [Nomad Enterprise](https://developer.hashicorp.com/nomad/docs/enterprise), is also available.
1515

16-
* Website: https://developer.hashicorp.com/nomad
17-
* Tutorials: [HashiCorp Developer](https://developer.hashicorp.com/nomad/tutorials)
16+
* [Documentation - concepts, user guides, reference](https://developer.hashicorp.com/nomad/docs)
17+
* [CLI docs](https://developer.hashicorp.com/nomad/commands)
18+
* [API docs](https://developer.hashicorp.com/nomad/api-docs)
19+
* [Nomad plugins docs](https://developer.hashicorp.com/nomad/plugins)
20+
* [Tutorials](https://developer.hashicorp.com/nomad/tutorials)
1821
* Forum: [Discuss](https://discuss.hashicorp.com/c/nomad)
1922

2023
Nomad provides several key features:
@@ -35,26 +38,23 @@ Quick Start
3538
---
3639

3740
#### Testing
38-
See [Developer: Getting Started](https://developer.hashicorp.com/nomad/tutorials/get-started) for instructions on setting up a local Nomad cluster for non-production use.
41+
Refer to the [Getting Started tutorials](https://developer.hashicorp.com/nomad/tutorials/get-started) for instructions on setting up a local Nomad cluster for non-production use.
3942

4043
Optionally, find Terraform manifests for bringing up a development Nomad cluster on a public cloud in the [`terraform`](terraform/) directory.
4144

4245
#### Production
43-
See [Developer: Nomad Reference Architecture](https://developer.hashicorp.com/nomad/tutorials/enterprise/production-reference-architecture-vm-with-consul) for recommended practices and a reference architecture for production deployments.
46+
Refer to [Production reference architecture](https://developer.hashicorp.com/nomad/docs/deploy/production/reference-architecture) for recommended practices and a reference architecture for production deployments.
4447

45-
Documentation
46-
---
47-
Full, comprehensive documentation is available on the Nomad website: https://developer.hashicorp.com/nomad/docs
48+
#### Documentation
4849

49-
Guides are available on [HashiCorp Developer](https://developer.hashicorp.com/nomad/tutorials).
50+
Nomad product documentation is stored in the [`web-unified-docs` repo](https://github.com/hashicorp/web-unified-docs/).
5051

51-
Roadmap
52-
---
52+
#### Roadmap
5353

5454
A timeline of major features expected for the next release or two can be found in the [Public Roadmap](https://github.com/orgs/hashicorp/projects/202/views/1).
5555

5656
This roadmap is a best guess at any given point, and both release dates and projects in each release are subject to change. Do not take any of these items as commitments, especially ones later than one major release away.
5757

58-
Contributing
59-
--------------------
58+
#### Contributing
59+
6060
See the [`contributing`](contributing/) directory for more developer documentation.

contributing/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This directory contains some documentation about the Nomad codebase,
55
aimed at readers who are interested in making code contributions.
66

77
If you're looking for information on _using_ Nomad, please instead refer
8-
to the [Nomad website](https://developer.hashicorp.com/nomad).
8+
to the [Nomad product documentation](https://developer.hashicorp.com/nomad).
99

1010
The [good first issue label](https://github.com/hashicorp/nomad/issues?q=is:issue+is:open+label:%22good+first+issue%22)
1111
is used to identify issues which are suited to first time contributors.

contributing/checklist-command.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,16 @@ CLI (command/) -> API Client (api/) -> HTTP API (command/agent) -> RPC (nomad/)
3636

3737
## Docs
3838

39-
* [ ] Changelog
39+
* [ ] Changelog entry in your code PR.
40+
41+
Find Nomad product docs in the `web-unified-docs` repo. Refer to the
42+
[`web-unified-docs` contributor
43+
guide](https://github.com/hashicorp/web-unified-docs/docs/contribute.md) for
44+
instructions. If you need help with docs, [create an issue in the web-unified
45+
docs repo](https://github.com/hashicorp/web-unified-docs/issues). On the Issue
46+
form, choose "Nomad" as the product so that your issue is assigned to the
47+
nomad-docs team.
48+
4049
* [ ] API docs https://developer.hashicorp.com/nomad/api
4150
* [ ] CLI docs https://developer.hashicorp.com/nomad/commands
42-
* [ ] If adding new docs see [website README](../website/README.md#editing-navigation-sidebars)
43-
* [ ] Consider if it needs a guide https://developer.hashicorp.com/nomad/guides/index.html
51+
* [ ] Consider if your change needs a user guide.

contributing/checklist-jobspec.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,20 @@ required in the original `jobspec` package.
3939

4040
## Docs
4141

42-
* [ ] Changelog
42+
* [ ] Changelog entry in your code PR.
43+
44+
Find Nomad product docs in the `web-unified-docs` repo. Refer to the
45+
[`web-unified-docs` contributor
46+
guide](https://github.com/hashicorp/web-unified-docs/docs/contribute.md) for
47+
instructions. If you need help with docs, [create an issue in the web-unified
48+
docs repo](https://github.com/hashicorp/web-unified-docs/issues). On the Issue
49+
form, choose "Nomad" as the product so that your issue is assigned to the
50+
nomad-docs team.
51+
4352
* [ ] Jobspec entry https://developer.hashicorp.com/nomad/docs/job-specification/index.html
44-
* [ ] Jobspec sidebar entry https://github.com/hashicorp/nomad/blob/main/website/data/docs-navigation.js
4553
* [ ] Job JSON API entry https://developer.hashicorp.com/nomad/api/json-jobs.html
4654
* [ ] Sample Response output in API https://developer.hashicorp.com/nomad/api/jobs.html
47-
* [ ] Consider if it needs a guide https://developer.hashicorp.com/nomad/guides/index.html
55+
* [ ] Consider if your change needs a user guide.
4856

4957
## JSON Encoding
5058

contributing/checklist-rpc-endpoint.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,15 @@ Prefer adding a new message to changing any existing RPC messages.
5454

5555
## Docs
5656

57-
* [ ] Changelog
57+
* [ ] Changelog in your code PR.
58+
59+
Find Nomad product docs in the `web-unified-docs` repo. Refer to the
60+
[`web-unified-docs` contributor
61+
guide](https://github.com/hashicorp/web-unified-docs/docs/contribute.md) for
62+
instructions. If you need help with docs, [create an issue in the web-unified
63+
docs repo](https://github.com/hashicorp/web-unified-docs/issues). On the Issue
64+
form, choose "Nomad" as the product so that your issue is assigned to the
65+
nomad-docs team.
66+
5867
* [ ] [Metrics](https://developer.hashicorp.com/nomad/docs/reference/metrics#server-metrics)
5968
* [ ] [API docs](https://developer.hashicorp.com/nomad/api-docs) for RPCs with an HTTP endpoint, include ACLs, params, and example response body.

0 commit comments

Comments
 (0)