Skip to content
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

Closed
wants to merge 2 commits into from
Closed

Conversation

cyschneck
Copy link
Contributor

@cyschneck cyschneck commented Feb 5, 2025

PR Summary

Update website language NCL description, pulled from README.md

Related Tickets & Documents

Closes #181

PR Checklist

General

  • PR includes a summary of changes
  • Link relevant issues, make one if none exist

@cyschneck cyschneck added the documentation Improvements or additions to documentation label Feb 5, 2025
@cyschneck cyschneck self-assigned this Feb 5, 2025
Copy link

github-actions bot commented Feb 5, 2025

Meowdy! See your PR preview:
🔍 Git commit SHA: e4748b2
✅ Deployment Preview URL: https://NCAR.github.io/geocat-applications/_preview/182

@cyschneck
Copy link
Contributor Author

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

@cyschneck cyschneck marked this pull request as ready for review February 5, 2025 22:36
Copy link
Collaborator

@kafitzgerald kafitzgerald left a 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.

@cyschneck cyschneck marked this pull request as draft February 10, 2025 18:03
@cyschneck
Copy link
Contributor Author

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

anissa111
anissa111 previously approved these changes Feb 10, 2025
@anissa111
Copy link
Member

Oh gosh, wrong tab sorry

@anissa111 anissa111 dismissed their stale review February 10, 2025 18:18

Review not requested, wrong tab

@cyschneck cyschneck marked this pull request as ready for review February 10, 2025 18:21
Copy link
Collaborator

@kafitzgerald kafitzgerald left a 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.

@cyschneck
Copy link
Contributor Author

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

@kafitzgerald
Copy link
Collaborator

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.

@cyschneck
Copy link
Contributor Author

I'll just close this PR then, the associated PR for Hugo was the more important piece of this anyway

@cyschneck cyschneck closed this Feb 10, 2025
@cyschneck cyschneck deleted the website_181 branch February 10, 2025 20:16
github-actions bot pushed a commit that referenced this pull request Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve website language
3 participants