Skip to content

Commit

Permalink
docs: change from v.3.5.2 suffix to release-3.5
Browse files Browse the repository at this point in the history
- [x] updated github issues config (like we did in main) to point to latest

Signed-off-by: jmeridth <[email protected]>
  • Loading branch information
jmeridth committed Jan 5, 2024
1 parent 2f6cf2c commit 6eb959f
Show file tree
Hide file tree
Showing 461 changed files with 494 additions and 494 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ blank_issues_enabled: false

contact_links:
- name: Have you read the docs?
url: https://argoproj.github.io/argo-workflows/
url: https://argo-workflows.readthedocs.io/en/latest
about: Much help can be found in the docs
- name: Ask a question
url: https://github.com/argoproj/argo-workflows/discussions/new
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ Argo is a [Cloud Native Computing Foundation (CNCF)](https://cncf.io/) graduated

## Use Cases

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

## Why Argo Workflows?

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

* [Get started here](docs/quick-start.md)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/v3.5.2/walk-through/)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/release-3.5/walk-through/)

## Documentation

[View the docs](https://argo-workflows.readthedocs.io/en/v3.5.2/)
[View the docs](https://argo-workflows.readthedocs.io/en/release-3.5/)

## 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/v3.5.2/workflow-pod-security-context/\n"
"Learn more at https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/tls/")
log.Warn("You are running in insecure mode. Learn how to enable transport layer security: https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/argo-server-auth-mode/")
log.Warn("You are running without client authentication. Learn how to enable client authentication: https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/workflow-executors/#emissary-emissary
// https://argo-workflows.readthedocs.io/en/release-3.5/workflow-executors/#emissary-emissary
Images map[string]Image `json:"images,omitempty"`

// Workflow retention by number of workflows
Expand Down
14 changes: 7 additions & 7 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/v3.5.2/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/v3.5.2/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/v3.5.2/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/v3.5.2/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/v3.5.2/use-cases/other/)
* [Machine Learning pipelines](https://argo-workflows.readthedocs.io/en/release-3.5/use-cases/machine-learning/)
* [Data and batch processing](https://argo-workflows.readthedocs.io/en/release-3.5/use-cases/data-processing/)
* [Infrastructure automation](https://argo-workflows.readthedocs.io/en/release-3.5/use-cases/infrastructure-automation/)
* [CI/CD](https://argo-workflows.readthedocs.io/en/release-3.5/use-cases/ci-cd/)
* [Other use cases](https://argo-workflows.readthedocs.io/en/release-3.5/use-cases/other/)

## Why Argo Workflows?

Expand Down Expand Up @@ -69,11 +69,11 @@ Check out our [Java, Golang and Python clients](https://github.com/argoproj/argo
## Quickstart

* [Get started here](https://github.com/argoproj/argo-workflows/blob/master/docs/quick-start.md)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/v3.5.2/walk-through/)
* [Walk-through examples](https://argo-workflows.readthedocs.io/en/release-3.5/walk-through/)

## Documentation

[View the docs](https://argo-workflows.readthedocs.io/en/v3.5.2/)
[View the docs](https://argo-workflows.readthedocs.io/en/release-3.5/)

## Features

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/v3.5.2/argo-server-auth-mode/
# https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/argo-server/
See https://argo-workflows.readthedocs.io/en/release-3.5/argo-server/
```

### Options
Expand Down
6 changes: 3 additions & 3 deletions docs/offloading-large-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,6 @@ size limit. To resolve, either enable node status offload as described
above or look for ways to reduce the size of your workflow manifest:

- Use `withItems` or `withParams` to consolidate similar templates into a single parametrized template
- Use [template defaults](https://argo-workflows.readthedocs.io/en/v3.5.2/template-defaults/) to factor shared template options to the workflow level
- Use [workflow templates](https://argo-workflows.readthedocs.io/en/v3.5.2/workflow-templates/) to factor frequently-used templates into separate resources
- Use [workflows of workflows](https://argo-workflows.readthedocs.io/en/v3.5.2/workflow-of-workflows/) to factor a large workflow into a workflow of smaller workflows
- Use [template defaults](https://argo-workflows.readthedocs.io/en/release-3.5/template-defaults/) to factor shared template options to the workflow level
- Use [workflow templates](https://argo-workflows.readthedocs.io/en/release-3.5/workflow-templates/) to factor frequently-used templates into separate resources
- Use [workflows of workflows](https://argo-workflows.readthedocs.io/en/release-3.5/workflow-of-workflows/) to factor a large workflow into a workflow of smaller workflows
2 changes: 1 addition & 1 deletion docs/retries.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Use `retryPolicy` to choose which failure types to retry:
- `Always`: Retry all failed steps
- `OnFailure`: Retry steps whose main container is marked as failed in Kubernetes
- `OnError`: Retry steps that encounter Argo controller errors, or whose init or wait containers fail
- `OnTransientError`: Retry steps that encounter errors [defined as transient](https://github.com/argoproj/argo-workflows/blob/master/util/errors/errors.go), or errors matching the `TRANSIENT_ERROR_PATTERN` [environment variable](https://argo-workflows.readthedocs.io/en/v3.5.2/environment-variables/). Available in version 3.0 and later.
- `OnTransientError`: Retry steps that encounter errors [defined as transient](https://github.com/argoproj/argo-workflows/blob/master/util/errors/errors.go), or errors matching the `TRANSIENT_ERROR_PATTERN` [environment variable](https://argo-workflows.readthedocs.io/en/release-3.5/environment-variables/). Available in version 3.0 and later.

The `retryPolicy` applies even if you also specify an `expression`, but in version 3.5 or later the default policy means the expression makes the decision unless you explicitly specify a policy.

Expand Down
2 changes: 1 addition & 1 deletion docs/running-nix.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Nix is a package manager / build tool which focuses on reproducible build enviro
Argo Workflows has some basic support for Nix which is enough to get Argo Workflows up and running with minimal effort.
Here are the steps to follow:

1. Modify your hosts file and set up a Kubernetes cluster according to [Running Locally](https://argo-workflows.readthedocs.io/en/v3.5.2/running-locally/). Don't worry about the other instructions.
1. Modify your hosts file and set up a Kubernetes cluster according to [Running Locally](https://argo-workflows.readthedocs.io/en/release-3.5/running-locally/). Don't worry about the other instructions.
1. Install [Nix](https://nixos.org/download.html).
1. Run `nix develop --extra-experimental-features nix-command --extra-experimental-features flakes ./dev/nix/ --impure` (you can add the extra features as a default in your `nix.conf` file).
1. Run `devenv up`.
Expand Down
2 changes: 1 addition & 1 deletion docs/walk-through/artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Artifacts are packaged as Tarballs and gzipped by default. You may customize thi

## Artifact Garbage Collection

As of version 3.4 you can configure your Workflow to automatically delete Artifacts that you don't need (visit [artifact repository capability](https://argo-workflows.readthedocs.io/en/v3.5.2/configure-artifact-repository/) for the current supported store engine).
As of version 3.4 you can configure your Workflow to automatically delete Artifacts that you don't need (visit [artifact repository capability](https://argo-workflows.readthedocs.io/en/release-3.5/configure-artifact-repository/) for the current supported store engine).

Artifacts can be deleted `OnWorkflowCompletion` or `OnWorkflowDeletion`. You can specify your Garbage Collection strategy on both the Workflow level and the Artifact level, so for example, you may have temporary artifacts that can be deleted right away but a final output that should be persisted:

Expand Down
4 changes: 2 additions & 2 deletions docs/workflow-controller-configmap.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,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/v3.5.2/workflow-executors/#emissary-emissary
# https://argo-workflows.readthedocs.io/en/release-3.5/workflow-executors/#emissary-emissary
images: |
argoproj/argosay:v2:
cmd: [/argosay]
Expand Down Expand Up @@ -372,7 +372,7 @@ data:
# SSO Configuration for the Argo server.
# You must also start argo server with `--auth-mode sso`.
# https://argo-workflows.readthedocs.io/en/v3.5.2/argo-server-auth-mode/
# https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/walk-through/).
This has been moved to [the docs](https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/configure-artifact-repository/#configuring-aws-s3
# For details, check out: https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/intermediate-inputs/ for details.
# See https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/key-only-artifacts/
# https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/configure-artifact-repository/#configuring-aws-s3
# For details, check out: https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/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/release-3.5/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/v3.5.2/installation/)
Please read [installation](https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/workflow-rbac/
# https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/workflow-rbac/
# https://argo-workflows.readthedocs.io/en/release-3.5/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/v3.5.2/",
"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/release-3.5/",
"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 @@ -1169,7 +1169,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/v3.5.2/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/release-3.5/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 @@ -433,7 +433,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/v3.5.2/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/release-3.5/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.

Loading

0 comments on commit 6eb959f

Please sign in to comment.