Skip to content

adding licensed tree #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

Draft
wants to merge 7 commits into
base: proposed_changes
Choose a base branch
from
Draft

Conversation

craigsteffen
Copy link
Collaborator

This branch is instantiating the licensed software tree in the main index so that it can be populated, integrated, and tested against everything else.

Setting up the licensed tree so that it can be filled in.
@craigsteffen craigsteffen requested review from rmokos and lhelms2 June 21, 2024 13:45
@craigsteffen craigsteffen self-assigned this Jun 21, 2024
Figuring out how the source positioning gets things in the final document.  I think this is closer to what we want.
Cleaning up some of the indexing to make it consistent.
Fixing indexing outline; getting spaces in between the proper lines.
Changing name to .rst to enable to be rendered and indexed.
@craigsteffen
Copy link
Collaborator Author

@rmokos I accidentally left this behind.

I have several branches that I need to revive, get composed, reviewed, and then rolled into the main branch. Do you have any other software that should be added in the next few weeks? I guess Matlab, now that we have a site license? Anything else?

Bringing the very old licensed software changes from last June branch
up to date with the just-updated proposed_changes (which got rolled
into main earlier today).  This should allow the license stuff to be a
quick merge once it's ready.
Rename software package index file to rst to activate and get in index.
@craigsteffen
Copy link
Collaborator Author

@greghbauer @rmokos
I'm sweeping up a bunch of documentation efforts that got assigned to me but then I left behind. This is probably the oldest one.

I have branch with an instantiated page for "licensed software". It's here on this branch:
https://docs.ncsa.illinois.edu/en/set_up_licensed/software/index.html

Currently it has one page instantiated for Gurobi optimizer. That just has one sentence in it.

It has single-sentence boilerplate pages for ansys, abaqus, fluent, and matlab (they're named as .txt files; you'll have to look in the repo, they're not on the page. We can instantiate and flesh out any or all of those, or leave them out.

Let me know if there's a minimum viable set of descriptions that you'd like to have on that page before we roll it into the proposed_changes and then out into the public main.

Craig

@pmenstrom
Copy link
Collaborator

I'm not sure what licenses should be listed but it might be nice if there were at least a few listed to start with.
The first line seemed a bit terse, maybe change it to "Listed below are packaged Third-party software available on NCSA computing resources."
In the Gurobi section, should there be an explanation on how to get/use the license?

@craigsteffen
Copy link
Collaborator Author

@pmenstrom
Yes to all of this. There are five placeholder pages in there (four of them named with .txt instead of .rst files so they don't show up in the built page) all of which have single-line boilerplate descriptions. I suspect generated by Lillian.

I'm pinging Ryan (and maybe Greg) to get a feel for which things they'd like to have actually listed and at what level of detail, so that we can target that threshold before bringing this into the main documentation pages.

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.

2 participants