-
Notifications
You must be signed in to change notification settings - Fork 5
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
Improve website language #182
Conversation
Meowdy! See your PR preview: |
Updated language on NCL index page, which was pulled from the description being used in the Github README.md. I'll move this language over to the Hugo website once this is discussed/merged |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems like a description of the overall NCL to Python section rather than the NCL Index.
I'm not opposed to adding a short description of the NCL Index here or a more detailed description of GeoCAT Applications to the GeoCAT website, but they should probably be different.
Updated/shorted the language to have a brief overview at the head of the NCL index. Hugo will have a longer description, but since most of this information already exists in the application's Getting Started page, it probably doesn't need to be repeated |
Oh gosh, wrong tab sorry |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess I'm not sure we need a description here. I think the header for the table is pretty self explanatory for this NCL Index page.
Do you think that it is descriptive enough without a header description if someone isn't familiar with what NCL is? All the other pages have a header description |
I don't think this section is really meant for folks who aren't coming from NCL so I guess that wasn't something I considered. Which I think is why we don't spell out what NCL is in the NCL to Python Applications section as well. In terms of adding a description, something like "Mapping of NCL functions to their Pythons equivalents and corresponding example notebooks" could work, but I don't know that it really adds all that much. The main purpose of the page is more the index than the notebooks so if we do include something here I think it should reflect that at least. |
I'll just close this PR then, the associated PR for Hugo was the more important piece of this anyway |
PR Summary
Update website language NCL description, pulled from README.md
Related Tickets & Documents
Closes #181
PR Checklist
General