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

fix: incorrect instructions for site documentation #13209

Merged
merged 2 commits into from
May 27, 2023

Conversation

reginapizza
Copy link
Contributor

I noticed the docs for how to build and serve documentation locally were wrong, so making this PR to correct it.
The make target for lint-docs was removed in #8722 but was never removed from documentation.

Proposed new changes look like:
Screenshot from 2023-04-12 16-20-45

Checklist:

  • Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • The title of the PR states what changed and the related issues number (used for the release note).
  • The title of the PR conforms to the Toolchain Guide
  • I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • Does this PR require documentation updates?
  • I've updated documentation as required by this PR.
  • Optional. My organization is added to USERS.md.
  • I have signed off all my commits as required by DCO
  • I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • My build is green (troubleshooting builds).
  • My new feature complies with the feature status guidelines.
  • I have added a brief description of why this PR is necessary and/or what this PR solves.

Please see Contribution FAQs if you have questions about your pull-request.

@codecov
Copy link

codecov bot commented Apr 12, 2023

Codecov Report

Patch coverage has no change and project coverage change: -0.03 ⚠️

Comparison is base (9ee9289) 49.04% compared to head (f190dc3) 49.01%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master   #13209      +/-   ##
==========================================
- Coverage   49.04%   49.01%   -0.03%     
==========================================
  Files         246      247       +1     
  Lines       42575    42685     +110     
==========================================
+ Hits        20882    20924      +42     
- Misses      19576    19645      +69     
+ Partials     2117     2116       -1     

see 9 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

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

docs/developer-guide/site.md Outdated Show resolved Hide resolved
Copy link
Member

@crenshaw-dev crenshaw-dev left a comment

Choose a reason for hiding this comment

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

Thanks, @reginapizza!

@crenshaw-dev crenshaw-dev merged commit 4a0b614 into argoproj:master May 27, 2023
@crenshaw-dev
Copy link
Member

/cherry-pick release-2.7

@crenshaw-dev
Copy link
Member

/cherry-pick release-2.6

gcp-cherry-pick-bot bot pushed a commit that referenced this pull request May 27, 2023
* fix: incorrect instructions for site documentation

Signed-off-by: Regina Scott <[email protected]>

* drop checking external links

Signed-off-by: Regina Scott <[email protected]>

---------

Signed-off-by: Regina Scott <[email protected]>
@crenshaw-dev
Copy link
Member

/cherry-pick release-2.5

gcp-cherry-pick-bot bot pushed a commit that referenced this pull request May 27, 2023
* fix: incorrect instructions for site documentation

Signed-off-by: Regina Scott <[email protected]>

* drop checking external links

Signed-off-by: Regina Scott <[email protected]>

---------

Signed-off-by: Regina Scott <[email protected]>
gcp-cherry-pick-bot bot pushed a commit that referenced this pull request May 27, 2023
* fix: incorrect instructions for site documentation

Signed-off-by: Regina Scott <[email protected]>

* drop checking external links

Signed-off-by: Regina Scott <[email protected]>

---------

Signed-off-by: Regina Scott <[email protected]>
crenshaw-dev pushed a commit that referenced this pull request May 27, 2023
)

* fix: incorrect instructions for site documentation



* drop checking external links



---------

Signed-off-by: Regina Scott <[email protected]>
Co-authored-by: Regina Scott <[email protected]>
crenshaw-dev pushed a commit that referenced this pull request May 27, 2023
)

* fix: incorrect instructions for site documentation



* drop checking external links



---------

Signed-off-by: Regina Scott <[email protected]>
Co-authored-by: Regina Scott <[email protected]>
crenshaw-dev pushed a commit that referenced this pull request May 27, 2023
)

* fix: incorrect instructions for site documentation



* drop checking external links



---------

Signed-off-by: Regina Scott <[email protected]>
Co-authored-by: Regina Scott <[email protected]>
schakrad pushed a commit to schakrad/argo-cd that referenced this pull request Jul 24, 2023
…) (argoproj#13773)

* fix: incorrect instructions for site documentation

* drop checking external links

---------

Signed-off-by: Regina Scott <[email protected]>
Co-authored-by: Regina Scott <[email protected]>
Signed-off-by: schakrad <[email protected]>
yyzxw pushed a commit to yyzxw/argo-cd that referenced this pull request Aug 9, 2023
* fix: incorrect instructions for site documentation

Signed-off-by: Regina Scott <[email protected]>

* drop checking external links

Signed-off-by: Regina Scott <[email protected]>

---------

Signed-off-by: Regina Scott <[email protected]>
tesla59 pushed a commit to tesla59/argo-cd that referenced this pull request Dec 16, 2023
* fix: incorrect instructions for site documentation

Signed-off-by: Regina Scott <[email protected]>

* drop checking external links

Signed-off-by: Regina Scott <[email protected]>

---------

Signed-off-by: Regina Scott <[email protected]>
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.

3 participants