Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: consolidate expression links #12617

Merged

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Feb 4, 2024

Follow-up to #12469 (comment) and #12573 (comment)

Motivation

Modifications

  • change internal docs references to expressions to go to variables.md#expression, the internal docs definition of it

  • change external references to go to https://expr-lang.org/docs/language-definition

  • while at it, make some small docs changes in the same place

    • more simple and direct, per k8s style guide
      • some of these, especially the data one, were incredibly overly verbose and have been greatly simplified
    • use present tense, per k8s style guide
    • prefer 1 sentence per line, per style guide

Verification

  1. make docs passes

- most of these should go to the definition in Argo's own docs in `variables.md#expression`
- use https://expr-lang.org/docs/language-definition instead of GH as it has nicer UX

- while at it, make some small docs changes in the same place
  - more simple and direct, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-simple-and-direct-language)
    - some of these, especially the `data` one, were incredibly overly verbose and have been greatly simplified
  - use present tense, per [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/#use-present-tense)
  - prefer 1 sentence per line, per [style guide](https://argo-workflows.readthedocs.io/en/release-3.5/doc-changes/)

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/templating Templating with `{{...}}` labels Feb 4, 2024
Copy link
Member

@isubasinghe isubasinghe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@isubasinghe isubasinghe merged commit 0cd37f2 into argoproj:main Feb 8, 2024
16 checks passed
@agilgur5 agilgur5 deleted the docs-consolidate-expression-links branch February 8, 2024 04:15
agilgur5 added a commit that referenced this pull request Apr 9, 2024
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
(cherry picked from commit 0cd37f2)
@agilgur5
Copy link
Member Author

agilgur5 commented Apr 9, 2024

Backported cleanly to release-3.5 as 1b1d200

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs area/templating Templating with `{{...}}`
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants