ioos / ioos-us

The homepage for the IOOS.us website
https://ioos.us/
MIT License
0 stars 16 forks source link

Compliance Checker landing page #182

Closed rps-aaron closed 5 years ago

rps-aaron commented 6 years ago

add compliance-checker landing page and homepage tile

Bobfrat commented 6 years ago

Thanks @rps-aaron! For future PRs, can you fork this repo and make a PR to master against your forked feature branch?

@BeckyBaltes @mwengren @jbosch-noaa @kknee Here's some screenshots of the compliance checker tile and page. It's pretty boring right now. Any suggestions on content? We could use a screenshot of a checker report for the page if you'd like.

Tile (bottom right):

screen shot 2018-06-05 at 7 00 20 pm

Page:

screen shot 2018-06-05 at 6 59 41 pm

jbosch-noaa commented 6 years ago

That's a good start. I forwarded this to our comms person to get her take on it. The checker report page is IMHO also kinda boring. Lets see what Kate comes up with. ... I'll give her until the end of the week.

Bobfrat commented 6 years ago

@jbosch-noaa any updates from Kate?

jbosch-noaa commented 6 years ago

Hey, sorry ... Kate and I talked about it and decided it might be good to have just a big check mark (like the Catalog magnifying glass). Is that something you can create?

Bobfrat commented 6 years ago

@rps-aaron can you make the compliance checker tile similar to this but with a checkmark?

screen shot 2018-06-18 at 2 41 42 pm

Bobfrat commented 6 years ago

@rps-aaron can you post a screenshot?

rps-aaron commented 6 years ago

Here's the screenshot. ioos-checker-tile

jbosch-noaa commented 6 years ago

It looks good.

Makes me think we need an icon for RAs and to maybe update the Data Demo Center to be a computer monitor or something to bring it into step with the others. Thoughts are welcome ...

Bobfrat commented 6 years ago

@jbosch-noaa what do you think about the page content? It's from the original issue here: https://github.com/ioos/ioos-us/issues/60

jbosch-noaa commented 6 years ago

@Bobfrat - The landing page is looking pretty good (I think). I do agree with your suggestion (in that email conversation with Ajay Kirshnan) that we should put a disclaimer on the page, alerting folks to the fact that the warning messages simply mean you haven’t met our interpretation of that check.

I hear folks asking the next question though .... "Does my file still follow the standards if I ignore these warnings?" I'm not sure what the best phrasing of that disclaimer should be .... lets think on it and throw out suggestions.

Bobfrat commented 6 years ago

@jbosch-noaa here's my first stab:

Disclaimer

The objective of the IOOS Compliance Checker is to check your file against our interpretation of select metadata standards for data providers to use as a guideline in generating compliant files. The compliance checker should not be considered the authoritative source on whether your file is 100% "compliant". Instead, we recommend that users use the results as a guide to work towards compliance.

jbosch-noaa commented 6 years ago

I like it. I am curious what @mwengren, and @dpsnowden think. If they are cool with it then I say go with it.

Bobfrat commented 6 years ago

@jbosch-noaa if approved, I can also add this text to the about page. https://compliance.ioos.us/about

jbosch-noaa commented 6 years ago

Hey @Bobfrat - I think it sounds good. I would want @mwengren and / or @dpsnowden to give the ultimate thumbs up though.

Bobfrat commented 5 years ago

@mwengren what do you think of the proposed content and disclaimer above for a compliance checker splash screen?

mwengren commented 5 years ago

Sorry for the non-response from before. I can't guarantee I'll see every GitHub mention because I'm sort of buried in GitHub email, guess I need to work on that.

What about a slight variation?

The objective of the IOOS Compliance Checker is to check your file against our interpretation of select dataset metadata standards to use as a guideline in generating compliant files. The compliance checker should not be considered the authoritative source on whether your file is 100% "compliant". Instead, we recommend that users use the results as a guide to work towards compliance.

Bobfrat commented 5 years ago

@rps-aaron can you rebase this PR and add the disclaimer text from above?