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.

Sign up for GitHub

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

Jump to bottom

Making docs index match better with github 'About' description #3338

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Making docs index match better with github 'About' description #3338

wants to merge 1 commit into from

Conversation

bmorris3
Copy link
Contributor

@bmorris3 bmorris3 commented Dec 5, 2024

Description

We just changed the About section of the repo from:

Screenshot 2024-12-05 at 11 54 51

to:

Screenshot 2024-12-05 at 11 54 51

This PR adjusts the main docs page to make it match more closely.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@bmorris3 bmorris3 added trivial Only needs one approval instead of two no-changelog-entry-needed changelog bot directive labels Dec 5, 2024
@bmorris3 bmorris3 added this to the 4.0.1 milestone Dec 5, 2024
@github-actions github-actions bot added the documentation Explanation of code and concepts label Dec 5, 2024
@codecov Codecov
Copy link

codecov bot commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.80%. Comparing base (3dc6573) to head (ba44ecb).
Report is 11 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3338      +/-   ##
==========================================
- Coverage   88.81%   88.80%   -0.01%     
==========================================
  Files         125      125              
  Lines       19041    19132      +91     
==========================================
+ Hits        16912    16991      +79     
- Misses       2129     2141      +12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

pllim
pllim approved these changes Dec 5, 2024
View reviewed changes
Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW LGTM TQVM FFTM 😸

@bmorris3
Copy link
Contributor Author

bmorris3 commented Dec 6, 2024

I'm only two for four on those abbreviations. 🤷🏻‍♂️

@rosteen
Copy link
Collaborator

rosteen commented Dec 6, 2024

I remember "Feel Free To Merge" but number 3 is escaping me.

@camipacifici
Copy link
Contributor

I am ok with changing the "about". How about adding in the docs something like:
"Built for the James Webb Space Telescope, Jdaviz works with imaging and spectroscopic observations obtained with various telescopes".

@camipacifici
Copy link
Contributor

TQVM = thank you very much??

@pllim
Copy link
Contributor

pllim commented Dec 9, 2024

"Built for the James Webb Space Telescope" might throw some people off, especially if they don't bother reading the rest of the sentence.

@pllim pllim modified the milestones: 4.0.1, 4.0.2, 4.1 Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pllim pllim pllim approved these changes

@rosteen rosteen Awaiting requested review from rosteen rosteen is a code owner

@javerbukh javerbukh Awaiting requested review from javerbukh javerbukh is a code owner

@kecnry kecnry Awaiting requested review from kecnry kecnry is a code owner

@haticekaratay haticekaratay Awaiting requested review from haticekaratay haticekaratay is a code owner

@cshanahan1 cshanahan1 Awaiting requested review from cshanahan1 cshanahan1 is a code owner

@gibsongreen gibsongreen Awaiting requested review from gibsongreen gibsongreen is a code owner

Assignees
No one assigned
Labels
documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive trivial Only needs one approval instead of two
Projects
None yet
Milestone
4.1
Development

Successfully merging this pull request may close these issues.
4 participants
@bmorris3 @rosteen @camipacifici @pllim