docs: swap master for main in Nomad repo
This commit is contained in:
Tim Gross
parent
454e8d0693
commit
2a2e36690a
|
|
@ -51,7 +51,7 @@ Developing without Vagrant
|
|||
|
||||
Running a development build
|
||||
---
|
||||
1. Compile a development binary (see the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) to include the web UI in the binary)
|
||||
1. Compile a development binary (see the [UI README](https://github.com/hashicorp/nomad/blob/main/ui/README.md) to include the web UI in the binary)
|
||||
```sh
|
||||
$ make dev
|
||||
# find the built binary at ./bin/nomad
|
||||
|
|
@ -79,7 +79,7 @@ If in the course of your development you change a Protobuf file (those ending in
|
|||
|
||||
Building the Web UI
|
||||
---
|
||||
See the [UI README](https://github.com/hashicorp/nomad/blob/master/ui/README.md) for instructions.
|
||||
See the [UI README](https://github.com/hashicorp/nomad/blob/main/ui/README.md) for instructions.
|
||||
|
||||
Create a release binary
|
||||
---
|
||||
|
|
|
|||
|
|
@ -36,7 +36,7 @@ required in the original `jobspec` package.
|
|||
|
||||
* [ ] Changelog
|
||||
* [ ] Jobspec entry https://www.nomadproject.io/docs/job-specification/index.html
|
||||
* [ ] Jobspec sidebar entry https://github.com/hashicorp/nomad/blob/master/website/source/layouts/docs.erb
|
||||
* [ ] Jobspec sidebar entry https://github.com/hashicorp/nomad/blob/main/website/data/docs-navigation.js
|
||||
* [ ] Job JSON API entry https://www.nomadproject.io/api/json-jobs.html
|
||||
* [ ] Sample Response output in API https://www.nomadproject.io/api/jobs.html
|
||||
* [ ] Consider if it needs a guide https://www.nomadproject.io/guides/index.html
|
||||
|
|
|
|||
|
|
@ -28,10 +28,10 @@ version.
|
|||
## Code
|
||||
|
||||
The
|
||||
[`update_golang_version.sh`](https://github.com/hashicorp/nomad/blob/master/scripts/update_golang_version.sh)
|
||||
[`update_golang_version.sh`](https://github.com/hashicorp/nomad/blob/main/scripts/update_golang_version.sh)
|
||||
script is used to update the Go version for all build tools.
|
||||
|
||||
The [Changelog](https://github.com/hashicorp/nomad/blob/master/CHANGELOG.md)
|
||||
The [Changelog](https://github.com/hashicorp/nomad/blob/main/CHANGELOG.md)
|
||||
will note when the Go version has changed in the Improvements section:
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -13,12 +13,12 @@ if [ "$2" != "$ent" -a -f version/version_ent.go ]; then
|
|||
fail "found enterprise version file version/version_ent.go while pushing to oss remote"
|
||||
fi
|
||||
|
||||
# don't push to master, stable-*
|
||||
# don't push to main, stable-*
|
||||
# ====================
|
||||
while read local_ref local_sha remote_ref remote_sha
|
||||
do
|
||||
if [ "$remote_ref" = "refs/heads/master" ]; then
|
||||
fail "refusing to push directly to master"
|
||||
if [ "$remote_ref" = "refs/heads/main" ]; then
|
||||
fail "refusing to push directly to main"
|
||||
fi
|
||||
|
||||
if echo "$remote_ref"|grep -q 'refs/heads/stable-.*'; then
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ The `NOMAD_E2E=1` environment variable must be set for these tests to run.
|
|||
The `terraform/` folder has provisioning code to spin up a Nomad cluster on
|
||||
AWS. You'll need both Terraform and AWS credentials to setup AWS instances on
|
||||
which e2e tests will run. See the
|
||||
[README](https://github.com/hashicorp/nomad/blob/master/e2e/terraform/README.md)
|
||||
[README](https://github.com/hashicorp/nomad/blob/main/e2e/terraform/README.md)
|
||||
for details. The number of servers and clients is configurable, as is the
|
||||
specific build of Nomad to deploy and the configuration file for each client
|
||||
and server.
|
||||
|
|
@ -103,7 +103,7 @@ nomad_version_client_linux = [
|
|||
|
||||
Set the `profile` field to `"custom"` and put the configuration files in
|
||||
`./terraform/config/custom/` as described in the
|
||||
[README](https://github.com/hashicorp/nomad/blob/master/e2e/terraform/README.md#Profiles).
|
||||
[README](https://github.com/hashicorp/nomad/blob/main/e2e/terraform/README.md#Profiles).
|
||||
|
||||
### ...Deploy More Than 4 Linux Clients
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ PKG_PATH = $(shell pwd)/../../pkg/linux_amd64/nomad
|
|||
|
||||
# The version of nomad that gets deployed depends on an order of precedence
|
||||
# linked below
|
||||
# https://github.com/hashicorp/nomad/blob/master/e2e/terraform/README.md#nomad-version
|
||||
# https://github.com/hashicorp/nomad/blob/main/e2e/terraform/README.md#nomad-version
|
||||
dev-cluster:
|
||||
terraform apply -auto-approve \
|
||||
-var="nomad_sha=$(NOMAD_SHA)"
|
||||
|
|
|
|||
|
|
@ -177,7 +177,7 @@ Before moving onto the next steps, ensure the following environment variables ar
|
|||
|
||||
## Build HashiStack Golden Image with Packer
|
||||
|
||||
[Packer](https://www.packer.io/intro/index.html) is HashiCorp's open source tool for creating identical machine images for multiple platforms from a single source configuration. The machine image created here can be customized through modifications to the [build configuration file](https://github.com/hashicorp/nomad/blob/master/terraform/gcp/packer.json) and the [shell script](https://github.com/hashicorp/nomad/blob/master/terraform/shared/scripts/setup.sh).
|
||||
[Packer](https://www.packer.io/intro/index.html) is HashiCorp's open source tool for creating identical machine images for multiple platforms from a single source configuration. The machine image created here can be customized through modifications to the [build configuration file](https://github.com/hashicorp/nomad/blob/main/terraform/gcp/packer.json) and the [shell script](https://github.com/hashicorp/nomad/blob/main/terraform/shared/scripts/setup.sh).
|
||||
|
||||
Use the following command to build the machine image:
|
||||
|
||||
|
|
@ -243,7 +243,7 @@ export VAULT_ADDR=http://localhost:8200
|
|||
|
||||
You have deployed a Nomad cluster to GCP! 🎉
|
||||
|
||||
Click [here](https://github.com/hashicorp/nomad/blob/master/terraform/README.md#test) for next steps.
|
||||
Click [here](https://github.com/hashicorp/nomad/blob/main/terraform/README.md#test) for next steps.
|
||||
|
||||
> ### After You Finish
|
||||
> Come back here when you're done exploring Nomad and the HashiCorp stack. In the next section, you'll learn how to clean up, and will destroy the demo infrastructure you've created.
|
||||
|
|
@ -268,4 +268,3 @@ gcloud projects delete $GOOGLE_PROJECT
|
|||
> ### Alternative: Use the GUI
|
||||
>
|
||||
> If you prefer to delete the project using GCP's Cloud Console, follow this link to GCP's [Cloud Resource Manager](https://console.cloud.google.com/cloud-resource-manager).
|
||||
|
||||
|
|
|
|||
|
|
@ -83,7 +83,7 @@ Nomad UI releases are in lockstep with Nomad releases and are integrated into th
|
|||
|
||||
### Storybook UI Library
|
||||
|
||||
The Storybook project provides a browser to see what components and patterns are present in the application and how to use them. You can run it locally with `yarn storybook` after you have `ember serve` running. The latest version from the `master` branch is at [`nomad-storybook-and-ui.vercel.app/storybook/`](https://nomad-storybook-and-ui.vercel.app/storybook/).
|
||||
The Storybook project provides a browser to see what components and patterns are present in the application and how to use them. You can run it locally with `yarn storybook` after you have `ember serve` running. The latest version from the `main` branch is at [`nomad-storybook-and-ui.vercel.app/storybook/`](https://nomad-storybook-and-ui.vercel.app/storybook/).
|
||||
|
||||
To generate a new story for a component, run `ember generate story component-name`. You can use the existing stories as a guide.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue