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 build instructions link #1014

Merged
merged 1 commit into from
Aug 2, 2023

Conversation

bryevdv
Copy link
Contributor

@bryevdv bryevdv commented Aug 1, 2023

cc @ipdemes @manopapad not sure if we want ot try and re-deploy existing docs or now. The "build" page does exist, just the link from the "install" page was wrong.

@bryevdv bryevdv added bug Something isn't working category:bug-fix PR is a bug fix and will be classified as such in release notes and removed bug Something isn't working labels Aug 1, 2023
@manopapad
Copy link
Contributor

re-deploy existing docs

is that easy to do @ipdemes ?

@manopapad
Copy link
Contributor

We should probably just set this up to happen automatically, instead of bothering someone to do it every time...

@ipdemes
Copy link
Contributor

ipdemes commented Aug 1, 2023

I will do it today (as soon as this PR is merged). But I agree that we probably want the process to be automatic in case I forget to update docs when needed.

@bryevdv
Copy link
Contributor Author

bryevdv commented Aug 1, 2023

Make what automatic, exactly?

If we deploy on every PR merge they would need to some dev/staging version for the next release. It would not make sense to update the previous docs automatically all the time, in case new features are in the latest branch that are not in the previous release. Or do you mean a GH action workflow_dispatch that can be manually kicked off when needed?

@manopapad
Copy link
Contributor

I think a nightly/weekly/on-every-top-of-tree-commit automatic push would make sense. You're right that these "bleeding-edge" docs should be marked as such, and not override the docs from previous releases.

@ipdemes
Copy link
Contributor

ipdemes commented Aug 2, 2023

I agree with Manolis that we could automatically update documentation for current release periodically or per request. For example, if someone has labeled the PR as "documentation". So we could control when exactly this should happen. It would be also nice to be able automatically generate docs for the new release every time we create a new release branch.

@bryevdv
Copy link
Contributor Author

bryevdv commented Aug 2, 2023

I'm going to go ahead and merge :)

@bryevdv bryevdv merged commit f89dd2a into nv-legate:branch-23.09 Aug 2, 2023
24 of 25 checks passed
@bryevdv bryevdv deleted the bv/fix-install-docs branch August 2, 2023 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category:bug-fix PR is a bug fix and will be classified as such in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants