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 versioned docs #5310

Merged
merged 7 commits into from Oct 25, 2022
Merged

docs: add versioned docs #5310

merged 7 commits into from Oct 25, 2022

Conversation

Jackmin801
Copy link
Contributor

Goals:

Docs Changes:

  • Added a version selector to the sidebar in docs/_templates/sidebar/brand.html.

CI changes:

  • Updates the Manual Docs Build workflow (.github/workflows/force-docs-build.yml).

    • This can be run whenever the docs are updated.
    • Changed some steps to be compatible with the new folder structure introduced by versioned docs
    • Increased modularity of steps to increase separation of concerns as well as increase visibility on time taken for each concern.
    • Decreased time taken to fetch code by changing fetches to shallow (depth 1)
  • Added the Build old docs workflow (.github/workflows/build-old-docs.yml)

    • This should be run when a new release is created (because there will be a new old release)
    • The workflow will build the docs for all the versions specified in docs/_versions.json of the main branch
    • Each version of the docs is built by checking out to the release, pulling the latest docs/_templates/sidebar/brand.html in main. Then building with makedoc.sh.
    • Each version is then placed in separate folders in ./docs of the pages_branch.
  • Updates the Release CD workflow (.github/workflows/tag.yml)

    • Add Build old docs trigger to dispatch
  • release.sh

    • Add logic to bump versions in _versions.json. This file is used by the Build old docs workflow to know which releases to build docs for

@Jackmin801 Jackmin801 changed the title Docs 5283 versioned docs docs: add versioned docs Oct 25, 2022
@github-actions github-actions bot added size/M area/cicd This issue/PR affects the cicd pipeline area/docs This issue/PR affects the docs area/housekeeping This issue/PR is housekeeping labels Oct 25, 2022
@codecov
Copy link

codecov bot commented Oct 25, 2022

Codecov Report

Merging #5310 (cd056f6) into master (fa4fc90) will decrease coverage by 1.04%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #5310      +/-   ##
==========================================
- Coverage   70.89%   69.84%   -1.05%     
==========================================
  Files          97       99       +2     
  Lines        6405     6451      +46     
==========================================
- Hits         4541     4506      -35     
- Misses       1864     1945      +81     
Flag Coverage Δ
jina 69.84% <ø> (-1.05%) ⬇️

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

Impacted Files Coverage Δ
jina/orchestrate/deployments/config/k8s.py 0.00% <0.00%> (-100.00%) ⬇️
...rate/deployments/config/k8slib/kubernetes_tools.py 0.00% <0.00%> (-100.00%) ⬇️
...a/orchestrate/deployments/config/docker_compose.py 0.00% <0.00%> (-99.02%) ⬇️
jina/orchestrate/deployments/config/helper.py 0.00% <0.00%> (-94.74%) ⬇️
...deployments/config/k8slib/kubernetes_deployment.py 0.00% <0.00%> (-57.90%) ⬇️
jina/parsers/deprecated.py 33.33% <0.00%> (-50.01%) ⬇️
jina/jaml/parsers/flow/v1.py 63.15% <0.00%> (-35.09%) ⬇️
jina/orchestrate/flow/base.py 61.70% <0.00%> (-25.90%) ⬇️
jina/serve/runtimes/gateway/websocket/gateway.py 92.85% <0.00%> (-5.36%) ⬇️
jina/serve/runtimes/gateway/http/gateway.py 93.65% <0.00%> (-4.77%) ⬇️
... and 49 more

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

@JoanFM JoanFM merged commit 03e482d into master Oct 25, 2022
@JoanFM JoanFM deleted the docs-5283-versioned-docs branch October 25, 2022 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/cicd This issue/PR affects the cicd pipeline area/docs This issue/PR affects the docs area/housekeeping This issue/PR is housekeeping size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants