Introducing RADIUSS policies and guidelines by adrienbernede · Pull Request #236 · llnl/llnl.github.io

adrienbernede · 2019-08-16T17:19:35Z

RADIUSS policies and guidelines are introduced in Markdown format.
The main page (radiuss-policies-guidelines.md) contains a short,
accessible version of the Mandatory and Recommended points with links to
the detailed versions.
The policies-guidelines.md contains on file per category, gathering the
detailed versions for each M & R.

RADIUSS policies and guidelines are introduced in Markdown format. The main page (radiuss-policies-guidelines.md) contains a short, accessible version of the Mandatory and Recommended points with links to the detailed versions. The policies-guidelines.md contains on file per category, gathering the detailed versions for each M & R.

LRWeber · 2019-08-16T17:24:07Z

Does this mean we should close #186 ?

hauten · 2019-08-16T17:28:39Z

Does this mean we should close #186 ?

Probably, but I want to give this a quick editorial pass & see how it's organized. @adrienbernede and I had kicked around a couple of ideas and, w/o looking at it yet, I'm not sure how it ended up. I'm sure it's all fine! Will review as soon as I can.

adrienbernede · 2019-08-16T17:29:39Z

The pull request is to replace the other #186 yes. But it need some "finalization" work.

adrienbernede · 2019-08-16T17:32:13Z

I forgot references.
@hauten instead of having one file per recommendation, I ended up with one per category.
As we discussed, all this could land in the same web-page with "jumps".

adrienbernede · 2019-08-16T18:26:21Z

I just added the missing references and external links.

hauten · 2019-08-20T22:18:48Z

@IanLee1521 & @adrienbernede see my latest commit 18d3be2.

Renamed index.md & "Policies" directory
Updated links accordingly
Applied page layout
Lightly edited
Added "Policies" to site header

I wasn't sure if I should add a permalink to each subpage. News and Archive have it but not the About pages. Necessary?

I remain on the fence about whether to include a "back to Policies home" (or similar link) at the top of the subpages. We aren't showing those pages in the site header, so the only way to get back to the parent page is to go back in your browser or to navigate to RADIUSS > Policies.

adrienbernede · 2019-08-20T22:23:44Z

@hauten The links in the index are not working in the github interface. I guess this is because they are written so that it works on the website, not on the repo. Right ?

adrienbernede · 2019-08-20T22:26:06Z

@hauten The "back to Policies home" will be unnecessary as soon as the menu will be in place, right ?

hauten · 2019-08-20T22:27:59Z

@hauten The links in the index are not working in the github interface. I guess this is because they are written so that it works on the website, not on the repo. Right ?

Yep, they worked locally as relative URLs

The "back to Policies home" will be unnecessary as soon as the menu will be in place right ?

Yes, when the have the "fancy" menu in place. But for now, there's no breadcrumb back up a level from, say, Documentation to the parent P&G page.

adrienbernede · 2019-08-20T22:32:23Z

OK, if adding a link back to the P&G page it a one-line thing I can pretty easily had it to all sub-pages.
You don’t like it because it would be temporary ?

hauten · 2019-08-20T22:35:54Z

OK, if adding a link back to the P&G page it a one-line thing I can pretty easily had it to all sub-pages.
You don’t like it because it would be temporary ?

I don't like it b/c we don't do it anywhere else. BUT we also don't have pages with these relationships anywhere else. So it's fine. Under {: .page-header}:
[Back to Policies and Guidelines home](/radiuss/policies/)

…in place)

adrienbernede · 2019-08-20T22:47:32Z

Once this branch is merged we can create an issue for the menu and reference commit 0d66c32 as "to be reverted".

IanLee1521

I think we should do better about who we display this information. Specifically, I think the information needs to stand on its own such that someone that isn't familiar with RADIUSS knows what they are looking at (and someone that IS familiar knows what they need to do.

@adrienbernede -- I'd like to see you or someone else from the team take the lead on that part as much as possible.

IanLee1521 · 2019-08-27T20:50:49Z

+{: .page-header}
+[Back to Policies and Guidelines home](/radiuss/policies/)
+
+**M.lic.1**  New RADIUSS products must use an [OSI](https://opensource.org/licenses)-approved, permissive open-source license (e.g., Apache, MIT, or BSD 3-Clause).  


I feel like the formatting here could be better. We should see what we can do to clean up how each of these items (M.lic.1, M.lic.2, etc) appear on the page. See screenshot below that is not super clear to an outsider what they are looking at.

You are right saying that the formatting is not OK. It was a bit better on github in my opinion, but not fantastic neither.

I’ll add an explanation for the naming (M - Mandatory, R - Recommended), as well as a short introduction of the section.

I would like to see the recommendation summary more visible, and the rationale is smaller font. Is it something related to the website configuration ?

Is there a way for me to visualize this changes ? I tried once to import the project and build it myself but quickly got stuck in completely unknown stuff.

I just added a link to the README that points more clearly to the Jekyll installation docs (https://github.com/llnl/llnl.github.io#getting-started)

If you're on a mac, these are the instructions I just used setting up my new computer: https://jekyllrb.com/docs/installation/macos/

adrienbernede · 2019-08-27T22:01:33Z

@IanLee1521, I suppose @steveg21 and I are to take the lead on the management of the RADIUSS "communication" on the website on behalf of Rob Neely, if that’s what you mean.

I have to admit that I was attempting to export the policies and the discussions around it from GitLab to GitHub, and so not focusing on proper presentation at first. But you are right that it is not well introduced and this would probably have been something to deal with pretty soon anyway.

IanLee1521 · 2019-08-27T22:03:11Z

No worries. Not trying to criticize, just want to make sure we get it to a point we can be proud of before we merge. :)

adrienbernede · 2019-08-27T22:06:24Z

Sure ! No harm done !

Few words to describe the intent of RADIUSS Policies and Guidelines, and who it is directed to. Changing font-size in quoteblock (typically used for rationale). Adding legend in every P&G section page.

adrienbernede · 2019-08-29T00:29:57Z

Made a mistake adding too many files, corrected.

adrienbernede · 2019-08-29T17:32:49Z

@IanLee1521 I made some improvements to make the P&G more pleasant to read, and introduce them better. I hope you’ll like the changes (as the first person seeing it). I had the introduction validated by Rob Neely.

IanLee1521 · 2019-08-30T18:12:38Z

No worries, there isn't really a set way.

I did just make a new "DO NOT MERGE" label though. Maybe in the fullness of time we can add that in to our bot checks? (cc/ @LRWeber)

Consistency between summarized and detailed views. Different colors for mandatory and recommended. Adapt legend. Corrections, merges and new stuff in the P&G.

Radiuss policies guidelines

There are two sentences that still seem very long to me. I’ll try to suggest a shorter version.

Fixing typos and suggested minor re-wording

Radiuss policies guidelines

adrienbernede · 2020-03-11T20:24:39Z

Need some help to solve conflicts on header.html, or will have to wait for some free brain time. :p

Solved conflicts adding P&G to navigation.

adrienbernede · 2020-03-19T00:41:07Z

Thanks @hauten for your help with the merge. @IanLee1521 the label do not merge can now be remove. This is ready for review.

adrienbernede · 2020-03-19T01:10:33Z

Thanks @IanLee1521

neely4 · 2020-03-20T19:23:16Z

@IanLee1521 @adrienbernede @hauten - I'm not sure why there's a conflict with those conflicting files, I don't think they were modified in this branch (that I know of). Can anyone help resolve this so we can get this PR merged up?

adrienbernede · 2020-03-20T19:33:20Z

@neely4 There are no more conflicts now. They were small anyway. The PR is ready as far as I can tell. You may want to quickly review these changes a0cfd1e
And that’s it.

neely4 · 2020-03-23T22:16:32Z

Thanks @adrienbernede. I don't use GitHub enough to know all the end cases, but this PR still has a big "Changes requested / Merging is blocked" notice in what I'm seeing, but the requested changes from Ian date back to last August and are no longer relevant. @IanLee1521 - are you OK with this branch as is?

IanLee1521

Was literally looking at this as Rob commented... :)

Approved, bit of feedback / suggestions:

I would add anchors to the policy / recommendation pages so that the links to them from the index are deep links that go directly to that point.

adrienbernede requested a review from a team as a code owner August 16, 2019 17:19

LRWeber mentioned this pull request Aug 16, 2019

WIP: Added RADIUSS Policies and Guidelines #186

Closed

Add references and external links

45971ed

Editorial and nav changes to new radiuss pages

18d3be2

Add a link back to the RADIUSS P&G main page (to revert when menu is …

0d66c32

…in place)

hauten mentioned this pull request Aug 21, 2019

Add dynamic navigation to RADIUSS Policies #245

Open

hauten previously approved these changes Aug 26, 2019

View reviewed changes

IanLee1521 suggested changes Aug 27, 2019

View reviewed changes

adrienbernede dismissed hauten’s stale review via e4861bf August 28, 2019 23:17

Introduction to RADIUSS P&G + formatting

ad6832b

Few words to describe the intent of RADIUSS Policies and Guidelines, and who it is directed to. Changing font-size in quoteblock (typically used for rationale). Adding legend in every P&G section page.

adrienbernede force-pushed the radiuss-policies-guidelines branch from e4861bf to ad6832b Compare August 29, 2019 00:28

Better formatting and use of badges

83c19e3

adrienbernede and others added 15 commits August 30, 2019 15:03

Multiple changes afer RADIUSS P&G meeting

5ed3cf4

Consistency between summarized and detailed views. Different colors for mandatory and recommended. Adapt legend. Corrections, merges and new stuff in the P&G.

Missing links in index

954edb3

Reworkd the policies and guidelines

e6b1252

Reworkd the policies and guidelines

5a7a2f5

Merge pull request #1 from neely4/radiuss-policies-guidelines

763f03d

Radiuss policies guidelines

Trigger Jekyll rebuild

7351c75

Trigger Jekyll rebuild

18f90b8

Broke up files to allow for original by-section, or a full flat printout

09f70d1

reorganized so a flat format is possible

4f291fd

Updates based on email feedback

9dc5c99

added legend.md

6395ea7

Fixing typos, basically

0b15bb3

There are two sentences that still seem very long to me. I’ll try to suggest a shorter version.

Holly's suggested changes to M.lic.2

88ed9ff

Merge pull request #1 from adrienbernede/patch-1

897c4aa

Fixing typos and suggested minor re-wording

Merge pull request #2 from neely4/radiuss-policies-guidelines

4cee632

Radiuss policies guidelines

adrienbernede added 3 commits March 16, 2020 16:50

Merge branch 'master' into radiuss-policies-guidelines-new

ba7b033

Solved conflicts adding P&G to navigation.

Changes after Cyrus suggestions (a while ago)

a0cfd1e

clean up

c4629de

IanLee1521 removed the DO NOT MERGE label Mar 19, 2020

Removed duplicate "common"

4efc385

IanLee1521 approved these changes Mar 23, 2020

View reviewed changes

IanLee1521 merged commit a23d6e1 into llnl:master Mar 23, 2020

adrienbernede mentioned this pull request Mar 23, 2020

Improvements to Radiuss P&G #332

Closed

Uh oh!

Conversation

adrienbernede commented Aug 16, 2019

Uh oh!

LRWeber commented Aug 16, 2019

Uh oh!

hauten commented Aug 16, 2019

Uh oh!

adrienbernede commented Aug 16, 2019

Uh oh!

adrienbernede commented Aug 16, 2019

Uh oh!

adrienbernede commented Aug 16, 2019

Uh oh!

hauten commented Aug 20, 2019

Uh oh!

adrienbernede commented Aug 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

adrienbernede commented Aug 20, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hauten commented Aug 20, 2019

Uh oh!

adrienbernede commented Aug 20, 2019

Uh oh!

hauten commented Aug 20, 2019

Uh oh!

adrienbernede commented Aug 20, 2019

Uh oh!

IanLee1521 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

IanLee1521 Aug 27, 2019

Choose a reason for hiding this comment

Uh oh!

adrienbernede Aug 27, 2019

Choose a reason for hiding this comment

Uh oh!

IanLee1521 Aug 27, 2019

Choose a reason for hiding this comment

Uh oh!

adrienbernede Aug 27, 2019

Choose a reason for hiding this comment

Uh oh!

adrienbernede Aug 29, 2019

Choose a reason for hiding this comment

Uh oh!

adrienbernede commented Aug 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

IanLee1521 commented Aug 27, 2019

Uh oh!

adrienbernede commented Aug 27, 2019

Uh oh!

adrienbernede commented Aug 29, 2019

Uh oh!

adrienbernede commented Aug 29, 2019

Uh oh!

IanLee1521 commented Aug 30, 2019

Uh oh!

adrienbernede commented Mar 11, 2020

Uh oh!

adrienbernede commented Mar 19, 2020

Uh oh!

adrienbernede commented Mar 19, 2020

Uh oh!

neely4 commented Mar 20, 2020

Uh oh!

adrienbernede commented Mar 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

neely4 commented Mar 23, 2020

Uh oh!

IanLee1521 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

adrienbernede commented Aug 20, 2019 •

edited

Loading

adrienbernede commented Aug 20, 2019 •

edited

Loading

adrienbernede commented Aug 27, 2019 •

edited

Loading

adrienbernede commented Mar 20, 2020 •

edited

Loading