search

DACCS-Climate / marble-tutorials

1 stars 1 forks source link

Alex tutorials - Getting Started #16

Closed alexandercyu closed 10 months ago

alexandercyu commented 11 months ago

Getting Started section

dchandan commented 11 months ago

I'll get to it soon, I'm sorry for the delay :(

alexandercyu commented 11 months ago

You could hold off for a bit. I'm working on Misha's requests right now. You can review the revisions later.

alexandercyu commented 11 months ago

I'll get to it soon, I'm sorry for the delay :(

I think the latest pushes are ready for you to take a look at.

mishaschwartz commented 11 months ago

@alexandercyu see suggested edits here: #20

I've made you a reviewer

mishaschwartz commented 11 months ago

@alexandercyu please do not merge this until we get additional feedback from the other reviewers

dchandan commented 10 months ago

Proposal: We should have a "Getting Support" page or something like that under "The Marble Platform" section. Here, we could summarize facts such as additional information about services and software components are available from the respective Github links provided on the main webpage, and questions can be asked on the "issues" section of the repos. And we could mention that nodes provide a contact email address, but response is not guaranteed. Eventually we can add reference to our discourse page. I imagine the content and structure of this page will evolve continually as we further refine the idea of what support we can, and are able to provide.

The "Getting Support" page can be started as a separate PR as well.

mishaschwartz commented 10 months ago

The "Getting Support" page can be started as a separate PR as well.

Good idea, please either make an issue for it or add it to #10

dchandan commented 10 months ago

One final organizational comment that comes to mind is about the headings we use and how we organize the content. Based on #10, it seems we wanted to have two top level "chapters" (in Jupyter Book lingo) one for "Users" and one for "Admin", and then we'd sub-divide the content based on the structure in that issue. It seems that with the organization in this PR we are not following that approach. Is this intentional?

dchandan commented 10 months ago

Something like this mockup: mockup

mishaschwartz commented 10 months ago

It seems that with the organization in this PR we are not following that approach. Is this intentional?

Not intentional. The plan was to make changes to the overall organization once we had more content (once #16, #17, and #19 were pulled in). But I'm fine if we start organizing better now

dchandan commented 10 months ago

OK, I'm reorganizing this in a branch I've branched from this branch.