Skip to content

Commit

Permalink
fix: documentation links (argoproj#12446)
Browse files Browse the repository at this point in the history
Signed-off-by: jmeridth <[email protected]>
  • Loading branch information
jmeridth authored Jan 2, 2024
1 parent 8235eab commit d1cae63
Show file tree
Hide file tree
Showing 457 changed files with 490 additions and 487 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ Argo is a [Cloud Native Computing Foundation (CNCF)](https://cncf.io/) graduated

## Use Cases

* [Machine Learning pipelines](https://argo-workflows.readthedocs.io/en/stable/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/stable/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/stable/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/stable/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/stable/use-cases/other/)
* [Machine Learning pipelines](https://argo-workflows.readthedocs.io/en/latest/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/latest/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/latest/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/latest/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/latest/use-cases/other/)

## Why Argo Workflows?

Expand Down Expand Up @@ -74,12 +74,12 @@ Check out our [Java, Golang and Python clients](docs/client-libraries.md).

## Quickstart

* [Get started here](https://argo-workflows.readthedocs.io/en/stable/quick-start/)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/stable/walk-through/)
* [Get started here](https://argo-workflows.readthedocs.io/en/latest/quick-start/)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/latest/walk-through/)

## Documentation

[View the docs](https://argo-workflows.readthedocs.io/en/stable/)
[View the docs](https://argo-workflows.readthedocs.io/en/latest/)

## Features

Expand Down
2 changes: 1 addition & 1 deletion api/openapi-spec/swagger.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion cmd/argo/commands/common/get_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ func Test_printWorkflowHelperNudges(t *testing.T) {

securityNudges := "This workflow does not have security context set. " +
"You can run your workflow pods more securely by setting it.\n" +
"Learn more at https://argo-workflows.readthedocs.io/en/stable/workflow-pod-security-context/\n"
"Learn more at https://argo-workflows.readthedocs.io/en/latest/workflow-pod-security-context/\n"

t.Run("SecuredWorkflow", func(t *testing.T) {
output := PrintWorkflowHelper(&securedWf, GetFlags{})
Expand Down
4 changes: 2 additions & 2 deletions cmd/argo/commands/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ See %s`, help.ArgoServer),
}

} else {
log.Warn("You are running in insecure mode. Learn how to enable transport layer security: https://argo-workflows.readthedocs.io/en/stable/tls/")
log.Warn("You are running in insecure mode. Learn how to enable transport layer security: https://argo-workflows.readthedocs.io/en/latest/tls/")
}

modes := auth.Modes{}
Expand All @@ -149,7 +149,7 @@ See %s`, help.ArgoServer),
}
}
if reflect.DeepEqual(modes, auth.Modes{auth.Server: true}) {
log.Warn("You are running without client authentication. Learn how to enable client authentication: https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/")
log.Warn("You are running without client authentication. Learn how to enable client authentication: https://argo-workflows.readthedocs.io/en/latest/argo-server-auth-mode/")
}

opts := apiserver.ArgoServerOpts{
Expand Down
2 changes: 1 addition & 1 deletion config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ type Config struct {
InitialDelay metav1.Duration `json:"initialDelay,omitempty"`

// The command/args for each image, needed when the command is not specified and the emissary executor is used.
// https://argo-workflows.readthedocs.io/en/stable/workflow-executors/#emissary-emissary
// https://argo-workflows.readthedocs.io/en/latest/workflow-executors/#emissary-emissary
Images map[string]Image `json:"images,omitempty"`

// Workflow retention by number of workflows
Expand Down
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Argo is a [Cloud Native Computing Foundation (CNCF)](https://cncf.io/) graduated

## Use Cases

* [Machine Learning pipelines](https://argo-workflows.readthedocs.io/en/stable/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/stable/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/stable/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/stable/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/stable/use-cases/other/)
* [Machine Learning pipelines](https://argo-workflows.readthedocs.io/en/latest/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/latest/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/latest/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/latest/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/latest/use-cases/other/)

## Why Argo Workflows?

Expand Down
2 changes: 1 addition & 1 deletion docs/argo-server-sso-argocd.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ metadata:
data:
# SSO Configuration for the Argo server.
# You must also start argo server with `--auth-mode sso`.
# https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/
# https://argo-workflows.readthedocs.io/en/latest/argo-server-auth-mode/
sso: |
# This is the root URL of the OIDC provider (required).
issuer: https://argo-cd.mydomain.com/api/dex
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/argo_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ argo server [flags]

```
See https://argo-workflows.readthedocs.io/en/stable/argo-server/
See https://argo-workflows.readthedocs.io/en/latest/argo-server/
```

### Options
Expand Down
7 changes: 5 additions & 2 deletions docs/workflow-controller-configmap.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
#######
# NEW URL FOR THIS FILE: https://argo-workflows.readthedocs.io/en/latest/workflow-controller-configmap.yaml
#######
# This file describes the config settings available in the workflow controller configmap
apiVersion: v1
kind: ConfigMap
Expand Down Expand Up @@ -201,7 +204,7 @@ data:
kubeletInsecure: "false"

# The command/args for each image, needed when the command is not specified and the emissary executor is used.
# https://argo-workflows.readthedocs.io/en/stable/workflow-executors/#emissary-emissary
# https://argo-workflows.readthedocs.io/en/latest/workflow-executors/#emissary-emissary
images: |
argoproj/argosay:v2:
cmd: [/argosay]
Expand Down Expand Up @@ -372,7 +375,7 @@ data:
# SSO Configuration for the Argo server.
# You must also start argo server with `--auth-mode sso`.
# https://argo-workflows.readthedocs.io/en/stable/argo-server-auth-mode/
# https://argo-workflows.readthedocs.io/en/latest/argo-server-auth-mode/
sso: |
# This is the root URL of the OIDC provider (required).
issuer: https://issuer.root.url/
Expand Down
2 changes: 1 addition & 1 deletion examples/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Documentation by Example

This has been moved to [the docs](https://argo-workflows.readthedocs.io/en/stable/walk-through/).
This has been moved to [the docs](https://argo-workflows.readthedocs.io/en/latest/walk-through/).
2 changes: 1 addition & 1 deletion examples/input-artifact-s3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ spec:
key: path/in/bucket
# Specify the bucket region. Note that if you want Argo to figure out this automatically,
# you can set additional statement policy that allows `s3:GetBucketLocation` action.
# For details, check out: https://argo-workflows.readthedocs.io/en/stable/configure-artifact-repository/#configuring-aws-s3
# For details, check out: https://argo-workflows.readthedocs.io/en/latest/configure-artifact-repository/#configuring-aws-s3
region: us-west-2
# accessKeySecret and secretKeySecret are secret selectors.
# It references the k8s secret named 'my-s3-credentials'.
Expand Down
2 changes: 1 addition & 1 deletion examples/intermediate-parameters.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# This example demonstrates the ability to use intermediate parameter.
# See https://argo-workflows.readthedocs.io/en/stable/intermediate-inputs/ for details.
# See https://argo-workflows.readthedocs.io/en/latest/intermediate-inputs/ for details.
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
Expand Down
2 changes: 1 addition & 1 deletion examples/key-only-artifact.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# this example shows how to use key-only artifacts - introduced in v3.0
# https://argo-workflows.readthedocs.io/en/stable/key-only-artifacts/
# https://argo-workflows.readthedocs.io/en/latest/key-only-artifacts/
apiVersion: argoproj.io/v1alpha1
kind: Workflow
metadata:
Expand Down
2 changes: 1 addition & 1 deletion examples/output-artifact-s3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ spec:
bucket: my-bucket
# Specify the bucket region. Note that if you want Argo to figure out this automatically,
# you can set additional statement policy that allows `s3:GetBucketLocation` action.
# For details, check out: https://argo-workflows.readthedocs.io/en/stable/configure-artifact-repository/#configuring-aws-s3
# For details, check out: https://argo-workflows.readthedocs.io/en/latest/configure-artifact-repository/#configuring-aws-s3
region: us-west-2

# NOTE: by default, output artifacts are automatically tarred and gzipped before saving.
Expand Down
2 changes: 1 addition & 1 deletion hack/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Find out on [our blog](https://blog.argoproj.io) and [changelog](https://github.

## Breaking Changes and Known Issues

Check the [upgrading guide](https://argo-workflows.readthedocs.io/en/stable/upgrading/) and search for [existing issues on GitHub](https://github.com/argoproj/argo-workflows/issues).
Check the [upgrading guide](https://argo-workflows.readthedocs.io/en/latest/upgrading/) and search for [existing issues on GitHub](https://github.com/argoproj/argo-workflows/issues).

## Installation

Expand Down
2 changes: 1 addition & 1 deletion manifests/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Argo Install Manifests

Please read [installation](https://argo-workflows.readthedocs.io/en/stable/installation/)
Please read [installation](https://argo-workflows.readthedocs.io/en/latest/installation/)
2 changes: 1 addition & 1 deletion manifests/quick-start/base/agent-role.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# https://argo-workflows.readthedocs.io/en/stable/workflow-rbac/
# https://argo-workflows.readthedocs.io/en/latest/workflow-rbac/
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
Expand Down
2 changes: 1 addition & 1 deletion manifests/quick-start/base/artifactgc-role.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# https://argo-workflows.readthedocs.io/en/stable/workflow-rbac/
# https://argo-workflows.readthedocs.io/en/latest/workflow-rbac/
apiVersion: rbac.authorization.k8s.io/v1
kind: Role
metadata:
Expand Down
2 changes: 1 addition & 1 deletion pkg/apiclient/_.primary.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"host": "localhost:2746",
"info": {
"title": "Argo Workflows API",
"description": "Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/stable/",
"description": "Argo Workflows is an open source container-native workflow engine for orchestrating parallel jobs on Kubernetes. For more information, please see https://argo-workflows.readthedocs.io/en/latest/",
"version": "VERSION"
},
"securityDefinitions": {
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/workflow_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -1173,7 +1173,7 @@ func (a *ArtifactLocation) Get() (ArtifactLocationType, error) {
} else if a.S3 != nil {
return a.S3, nil
}
return nil, fmt.Errorf("You need to configure artifact storage. More information on how to do this can be found in the docs: https://argo-workflows.readthedocs.io/en/stable/configure-artifact-repository/")
return nil, fmt.Errorf("You need to configure artifact storage. More information on how to do this can be found in the docs: https://argo-workflows.readthedocs.io/en/latest/configure-artifact-repository/")
}

// SetType sets the type of the artifact to type the argument.
Expand Down
2 changes: 1 addition & 1 deletion pkg/apis/workflow/v1alpha1/workflow_types_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ func TestArtifactLocation_Get(t *testing.T) {

v, err = (&ArtifactLocation{}).Get()
assert.Nil(t, v)
assert.EqualError(t, err, "You need to configure artifact storage. More information on how to do this can be found in the docs: https://argo-workflows.readthedocs.io/en/stable/configure-artifact-repository/")
assert.EqualError(t, err, "You need to configure artifact storage. More information on how to do this can be found in the docs: https://argo-workflows.readthedocs.io/en/latest/configure-artifact-repository/")

v, _ = (&ArtifactLocation{Azure: &AzureArtifact{}}).Get()
assert.IsType(t, &AzureArtifact{}, v)
Expand Down
2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/__init__.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/api/event_service_api.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/api/info_service_api.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/api_client.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/configuration.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion sdks/python/client/argo_workflows/exceptions.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit d1cae63

Please sign in to comment.