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: Make https://argoproj.github.io/argo/ #3369

Merged
merged 38 commits into from Jul 8, 2020
Merged

Conversation

alexec
Copy link
Contributor

@alexec alexec commented Jul 1, 2020

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
  • The title of the PR is (a) conventional, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
  • I've signed the CLA.
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My builds are green. Try syncing with master if they are not.
  • My organization is added to USERS.md.

https://argoproj.github.io/argo/

Tasks

Fix Elsewhere

See #934 (aggregate) pattern we should document in user guide
See #3295 (workflow of workflows) @sarabala1979 to fix
See #3202 (broken link) @simster7 to fix
See #2665 (DB schema docs) should we fix?
See #716 (base URL) confuses users, should fix

Under Consideration

See #2922 (CLI docs) can we do this automagically? investigate

Rejected

See #3057 (metrics)
See #2683 (CLI on windows)
See #2358 (OSS docs) - won't fix
See #1629 won't fix
See #3331

@alexec alexec added the type/feature Feature request label Jul 1, 2020
@alexec alexec marked this pull request as ready for review July 1, 2020 18:10
@alexec alexec requested a review from simster7 July 1, 2020 18:10
@alexec alexec requested a review from sarabala1979 July 1, 2020 18:10
@@ -0,0 +1,28 @@
name: Deploy
Copy link
Contributor Author

Choose a reason for hiding this comment

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

automatically publish docs

Copy link
Member

Choose a reason for hiding this comment

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

Nice! This is great

@alexec alexec marked this pull request as draft July 1, 2020 18:11
@alexec alexec mentioned this pull request Jul 1, 2020
@alexec alexec linked an issue Jul 1, 2020 that may be closed by this pull request
Comment on lines -14 to -19

### Features
Some use-case specific documentation is available:

* [Contributing](CONTRIBUTING.md)
* [Access Token](access-token.md)
Copy link
Member

Choose a reason for hiding this comment

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

Where is this going to go? Is it getting removed entirely?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

mkdocs will create an index from on mkdoc.yaml

@@ -0,0 +1,71 @@
## argo
Copy link
Member

Choose a reason for hiding this comment

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

CLI docs are a great add!

@alexec alexec marked this pull request as ready for review July 8, 2020 20:24
@alexec alexec merged commit 3507c3e into argoproj:master Jul 8, 2020
@alexec alexec deleted the mkdocs branch July 8, 2020 21:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/feature Feature request
Projects
None yet
2 participants