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: add CRD specification example files to docs #14021

Merged
merged 3 commits into from
Jun 19, 2023

Conversation

crenshaw-dev
Copy link
Member

@crenshaw-dev crenshaw-dev commented Jun 13, 2023

Similar to what Rollouts has: https://argo-rollouts.readthedocs.io/en/stable/features/specification/#examples

I also added dedicated pages for declarative config example files.

This prevents users from having to click out of the docs site to raw files in order to see examples. Now they can stay in the nice-looking, easily-navigable docs site.

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
@crenshaw-dev crenshaw-dev marked this pull request as ready for review June 13, 2023 19:57
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
@codecov
Copy link

codecov bot commented Jun 13, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (a952b01) 49.61% compared to head (1c7ed36) 49.61%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master   #14021   +/-   ##
=======================================
  Coverage   49.61%   49.61%           
=======================================
  Files         256      256           
  Lines       43934    43934           
=======================================
+ Hits        21797    21800    +3     
+ Misses      19977    19975    -2     
+ Partials     2160     2159    -1     

see 2 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@zachaller
Copy link
Contributor

This is a great addition and provides so much insight into what options and feature set argocd has.

Copy link
Contributor

@todaywasawesome todaywasawesome left a comment

Choose a reason for hiding this comment

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

Looks good

@pasha-codefresh
Copy link
Member

Great job, thank you

@pasha-codefresh pasha-codefresh merged commit 698aef3 into argoproj:master Jun 19, 2023
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
* docs: add CRD specification example files to docs

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>

* pages for declarative files, too

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>

---------

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
* docs: add CRD specification example files to docs

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>

* pages for declarative files, too

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>

---------

Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
Co-authored-by: pasha-codefresh <pavel@codefresh.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants