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: Fix local guide for building and testing docs #19785

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Conversation

todaywasawesome
Copy link
Contributor

@todaywasawesome todaywasawesome commented Sep 4, 2024

Small chore to fix the local documentation build guide. The makefile wasn't working reliably and the guide it self was a bit confusing because it only talked about the docs site as just "the site" which sounds like the website.

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.
  • 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.
  • Optional. My organization is added to USERS.md.
  • Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

Signed-off-by: todaywasawesome <dan@codefresh.io>
@todaywasawesome todaywasawesome requested review from a team as code owners September 4, 2024 16:02
Copy link

bunnyshell bot commented Sep 4, 2024

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

Copy link

bunnyshell bot commented Sep 4, 2024

❌ Preview Environment deleted from Bunnyshell

Available commands (reply to this comment):

  • 🚀 /bns:deploy to deploy the environment

Copy link

codecov bot commented Sep 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (master@f071fdc). Learn more about missing BASE report.
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master   #19785   +/-   ##
=========================================
  Coverage          ?   55.89%           
=========================================
  Files             ?      320           
  Lines             ?    44057           
  Branches          ?        0           
=========================================
  Hits              ?    24627           
  Misses            ?    16881           
  Partials          ?     2549           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@todaywasawesome todaywasawesome added documentation Issue is related to missing or incorrect documentation type:docs Missing or incomplete documentation labels Sep 4, 2024
@ishitasequeira ishitasequeira merged commit 9c47a70 into master Sep 5, 2024
36 of 41 checks passed
@ishitasequeira ishitasequeira deleted the docsdev branch September 5, 2024 00:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue is related to missing or incorrect documentation type:docs Missing or incomplete documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants