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: various fixes #355

Merged
merged 3 commits into from
Aug 22, 2023
Merged

Conversation

ncdc
Copy link
Member

@ncdc ncdc commented Aug 22, 2023

Description

  • Fix rendering issues with main docs page
  • Fix roadmap link, nav links
  • GH workflows:
    • Support manual triggering
    • Trigger on PRs to test site builds
    • Only trigger if docs-related files were changed
    • Switch to standard setup-python/pip caching
    • Add concurrency group
  • Add 'make serve-docs' to serve locally using a venv
  • Add 'make build-docs' to build locally using a venv
  • Add 'make deploy-docs' to build locally and deploy to gh-pages using a venv
  • Freeze pip deps using requirements.txt

Reviewer Checklist

  • API Go Documentation
  • Tests: Unit Tests (and E2E Tests, if appropriate)
  • Comprehensive Commit Messages
  • Links to related GitHub Issue(s)

Fix indentation of bulleted lists so they render correctly.

Fix some typos.

Fix URL to roadmap.

Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
@ncdc ncdc requested a review from a team as a code owner August 22, 2023 19:01
@codecov
Copy link

codecov bot commented Aug 22, 2023

Codecov Report

Merging #355 (6f47998) into main (6770469) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #355   +/-   ##
=======================================
  Coverage   82.84%   82.84%           
=======================================
  Files          21       21           
  Lines         892      892           
=======================================
  Hits          739      739           
  Misses        107      107           
  Partials       46       46           
Flag Coverage Δ
e2e 62.66% <ø> (ø)
unit 78.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

GH workflows:
- Support manual triggering
- Trigger on PRs to test site builds
- Only trigger if docs-related files were changed
- Switch to standard setup-python/pip caching
- Add concurrency group

Add 'make serve-docs' to build locally using a venv

Freeze pip deps using requirements.txt

Signed-off-by: Andy Goldstein <andy.goldstein@redhat.com>
@joelanford joelanford added this pull request to the merge queue Aug 22, 2023
Merged via the queue into operator-framework:main with commit 5045b75 Aug 22, 2023
11 checks passed
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.

2 participants