-
Notifications
You must be signed in to change notification settings - Fork 0
SP-1635: page for per-account user compute resources #35
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
base: main
Are you sure you want to change the base?
Conversation
eaa3589
to
1406667
Compare
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.
First, could you name the PR? I'd recommend: SP-1635: Document account resources
. This makes it easier for the RSP team.
Second, could you consider rebasing and squashing many of the commits: https://docs.github.com./en/get-started/using-git/using-git-rebase-on-the-command-line I've noticed a lot of repeated "Update ..." type commits in the Git history and they've made it harder to keep up to date with rsp_lsst_io
.
Recommendations for this page:
I'd recommend shortening the URL a bit: docs/guide/resources
.
Another thing to consider is separating what resources are given to a user from the overall platform capacity. Right now both are stated in the same sections. The information actionable to a user is their own quotas, and I think that information should come first. The platform capacity and estimates of how many users can be on the platform before it degrades can be a later reference section because it's not action-able information to our users.
Lastly, I notice a lot of intended footnotes in this page. Here's the syntax for creating footnotes in reStructuredText: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes The native syntax links between the footnote marker and the footnote, so it's useful.
docs/guides/account-resources/user-account-resources.primary.in.rst
Outdated
Show resolved
Hide resolved
1406667
to
60faa7e
Compare
Thanks @jonathansick. Agree on all suggestions and incorporated them all in one commit.
I'd kind of wanted the "footnotes" to be within each subsection but I switched to using the RST format for bottom-of-the-page footnotes. |
Not merging and not requesting review because this page is not finished, still awaiting inputs and final quantity estimates. |
8c36ee0
to
fed0406
Compare
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.
ok for me - TBDs need SQuaRE and USDF to comment
Add comp proc sec
add storage and backups
fix bullets, add query and memory limits
Fix formatting.
Add link to RTN-084.
fed0406
to
334fcbd
Compare
Add new page summarizing RSP user resources (storage, compute, etc.).