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

Added RMACC allocation info to allocations.md #375

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

Conversation

jreiland
Copy link
Contributor

No description provided.

@jreiland jreiland requested a review from b-reyes October 18, 2024 21:14
Copy link
Contributor

@b-reyes b-reyes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the information you provided is fine. I personally think that if we are going to make this change then this page should just be revamped instead. Each affiliated institution has an general and projects associated with them. This page does not make that clear. Additionally, it is hard to discern that only UCB users can get ascent/peak allocations. To further confuse things you have the RMACC allocation in the "Alpine Allocation Tiers" section. I think incorporating it as you did made sense for what you were given, but I think we can do better on this page.

I don't know what would be best here, but I propose the following:

  • Generalize the the subsection Allocations so it can apply to any institution
  • Reformat the section Alpine Allocation Tiers and all sections below that so it splits it up across the institutions i.e. UCB, AMC, RMACC, and CSU. I think this could be a good place to use tabs.

docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
@jreiland
Copy link
Contributor Author

@LRFreeborn Please let us know what you think is best for this and let me know if you need help rendering a preview of the updates.

@jreiland jreiland requested a review from LRFreeborn October 22, 2024 21:20
Copy link
Contributor

@LRFreeborn LRFreeborn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See inline comments.

I'd also like for us add a 'RMACC' column to the table, since we're making a strong distinction between RMACC and CU Boulder Ascent allocations.

I suppose we should also format this table so that it's coded into the markdown file rather than inserted as a picture.

docs/clusters/alpine/allocations.md Show resolved Hide resolved
docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
docs/clusters/alpine/allocations.md Show resolved Hide resolved
docs/clusters/alpine/allocations.md Show resolved Hide resolved
docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
docs/clusters/alpine/allocations.md Outdated Show resolved Hide resolved
@LRFreeborn
Copy link
Contributor

Please don't add information about CSU's allocations to this page; I don't want our team to be responsible for distributing information about a process we don't own.

@LRFreeborn
Copy link
Contributor

LRFreeborn commented Nov 19, 2024

It's up to you (John) to decide if you want to mention ucb-projects. If you did, I can see it going well as an extension of this sentence,
"One way to combat this is to apply for an allocation."
e.g., "... , which gives you access to the larger pool of resources contained within the ucb-projects or rmacc-projects accounts."

@jreiland
Copy link
Contributor Author

See inline comments.

I'd also like for us add a 'RMACC' column to the table, since we're making a strong distinction between RMACC and CU Boulder Ascent allocations.

I suppose we should also format this table so that it's coded into the markdown file rather than inserted as a picture.

We may want to clarify what we want in the table. I feel some things could be removed or abbreviated to make it more readable/nice.

@jreiland
Copy link
Contributor Author

Also fixed #356

@b-reyes
Copy link
Contributor

b-reyes commented Dec 17, 2024

In the Level Fairshare section replace here with appropriate title and make note an admonition (see image)

Screenshot 2024-12-17 at 3 17 30 PM

@b-reyes
Copy link
Contributor

b-reyes commented Dec 17, 2024

I know Layla and you talked about this, but I think the Allocations section layout can be improved. I don't like that the institutions are mixed and not put in tabs. The reason for this is it is not immediately clear what each institution gets access to. They have to do a good amount of reading to figure this out. I think the different institutions should be put in tabs with the appropriate info displayed. I put together a terrible sketch of how this would look:

Screenshot 2024-12-17 at 3 41 42 PM

Copy link
Contributor

@b-reyes b-reyes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done doing an initial review. I would like some layout changes. Once these are done, I can review the actual content.

docs/clusters/alpine/allocations.md Show resolved Hide resolved
@b-reyes
Copy link
Contributor

b-reyes commented Dec 18, 2024

@jreiland I found the link for using substitutions. It is basically their way to introduce variables that we can use in our Markdown files. It should just work, as long as you enable the extension and put items in the conf.py. Let me know if you need help, but I think this would be a cool thing to test drive in this PR.

@jreiland
Copy link
Contributor Author

jreiland commented Dec 20, 2024

Note that the way to use substitutions: https://myst-parser.readthedocs.io/en/v0.15.1/syntax/optional.html#syntax-substitutions:~:text=Substitutions%20(with%20Jinja2)-,¶,-Adding%20%22substitution%22

When you want to do for each page (rather than the whole set of docs), their syntax is deprecated (according to error message from Sphinx). Please do:

---
myst:
    substitutions:
        key1: "value1"
---

instead of just:

---
substitutions:
    key1: "value1"
---

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants