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

devops: Stop publishing doc.zebra.zfnd.org and change links to docs.rs/zebrad/latest #7837

Closed
3 tasks done
teor2345 opened this issue Oct 26, 2023 · 3 comments · Fixed by #7886
Closed
3 tasks done
Assignees
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-cleanup Category: This is a cleanup

Comments

@teor2345
Copy link
Contributor

teor2345 commented Oct 26, 2023

Describe the issue or request

As long as we do regular releases, https://doc.zebra.zfnd.org will be a duplicate of https://docs.rs/zebrad/latest (there are also docs.rs for the other Zebra crates). So there's no point in having it.

There are some bugs like #7048 that only happen in our docs.

The internal docs are still useful, because they show private items and all features for the main branch.

Possible Solution

  • Change all the Zebra repository links for doc.zebra.zfnd.org to docs.rs/zebrad/latest
  • Remove the external docs job
  • Admin: remove the branch protection rule
@teor2345 teor2345 added A-docs Area: Documentation A-devops Area: Pipelines, CI/CD and Dockerfiles C-cleanup Category: This is a cleanup S-needs-triage Status: A bug report needs triage P-Low ❄️ labels Oct 26, 2023
@mpguerra mpguerra added this to Zebra Oct 26, 2023
@github-project-automation github-project-automation bot moved this to 🆕 New in Zebra Oct 26, 2023
@mpguerra
Copy link
Contributor

@teor2345 do you still want to do this one during this sprint?

@teor2345
Copy link
Contributor Author

There doesn't seem to be much else for me to do, and it's a quick change.

@teor2345 teor2345 self-assigned this Oct 26, 2023
@teor2345
Copy link
Contributor Author

teor2345 commented Nov 1, 2023

  • Admin: remove the branch protection rule

I removed the branch protection rule because it won't be needed once the PR merges.

@mergify mergify bot closed this as completed in #7886 Nov 1, 2023
@github-project-automation github-project-automation bot moved this from 🆕 New to ✅ Done in Zebra Nov 1, 2023
@mpguerra mpguerra removed the S-needs-triage Status: A bug report needs triage label Nov 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-devops Area: Pipelines, CI/CD and Dockerfiles A-docs Area: Documentation C-cleanup Category: This is a cleanup
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants