-
Notifications
You must be signed in to change notification settings - Fork 3
Add notice about the relocation of docs #53
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
Conversation
Fix admonition name. "Attention" is not a valid admonition name in GitHub.
supl
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Thank you, Josh 🙇
Sorry, I might have missed the discussion.
Do we plan to remove the docs folder in each repository in the future? (To not leave outdated materials)
fd53a95 to
e600134
Compare
@supl Yes, that's correct. After we have confirmed that all docs are in the private, centralized docs repository and that we don't encounter any problems in that centralized repository, we will remove the |
jnmt
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you!
feeblefakie
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thank you!
Description
This PR adds a cautionary notice to the top of docs in the
docsfolder. Since those docs should now be updated in the scalar-labs/docs-internal repository, the cautionary notice that I've added here is to provide guidance for those who may not know where to update the docs.Note
If the cautionary notice that I've added in this PR looks OK, I'll submit a similar PR that includes adding the same cautionary notice to docs in other ScalarDL-related repositories.
Related issues and/or PRs
N/A
Changes made
docsfolder, stating that the doc should be updated in the scalar-labs/docs-internal repository.Checklist
Additional notes (optional)
The
docsfolder in this repository can be deleted after we have moved all product docs to the scalar-labs/docs-internal repository and confirmed that the migration was a success.Release notes
N/A