Skip to content

Documentation homepage, use of panels for visibility to users #3884

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
Merged
merged 9 commits into from
Sep 29, 2020
Merged

Documentation homepage, use of panels for visibility to users #3884

merged 9 commits into from
Sep 29, 2020

Conversation

tkknight
Copy link
Contributor

🚀 Pull Request

Description

Added some panels and use of badges on the documentation index, in order to make it more visible to users.

  • The link to the legacy docs was in a note, now moved to lower on the page and uses a badge link instead.
  • Added panels using the sphinx-panels extension.
  • Made the index on the main body hidden, now it only appears in the sidebar.
  • Added the dependency for sphinx-panels.
  • Moved the Iris API link in the sidebar to the Reference section

You can view all rendered changes at https://iris-test-doc.readthedocs.io/en/latest/ for the lifetime of this PR.

Consult Iris pull request check list

@tkknight tkknight added this to the v3.0.0 milestone Sep 28, 2020
@tkknight tkknight mentioned this pull request Sep 28, 2020
Closed
@tkknight
Copy link
Contributor Author

any thoughts @SciTools/iris-devs?

@pp-mo
Copy link
Member

pp-mo commented Sep 28, 2020

👍 really like the improved clarity of this (and incorporating #3880).
Can't find anything to fault with this, but I will leave @bjlittle to complete review

@rcomer rcomer linked an issue Sep 28, 2020 that may be closed by this pull request
API Link #3880
Closed
rcomer
rcomer reviewed Sep 28, 2020
View reviewed changes
Copy link
Member

@rcomer rcomer left a comment

Choose a reason for hiding this comment

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

Definitely like the buttons. I just have some suggestions for some of the descriptions which you are free to adapt or ignore as you see fit!

docs/iris/src/index.rst Outdated
:text: Gallery
:classes: btn-outline-primary btn-block
---
Find out what has recently been added to Iris, or soon will be.
Copy link
Member

Choose a reason for hiding this comment

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

Not sure about the "soon will be", as this won't make sense for the released docs. Also this is currently pointing to a list of all the whatsnews. Should it just be the whatsnew for the current version? If intended to point to all versions, maybe "Find out what has changed in Iris" would be more all-encompassing.

Copy link
Contributor

Choose a reason for hiding this comment

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

To be fair, all of it has been recently added to Iris, but only some of it has been released so far.

Copy link
Member

Choose a reason for hiding this comment

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

In fact, some things have be removed from Iris....

Copy link
Contributor Author

Choose a reason for hiding this comment

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

how about:

"Find out what has recently changed in Iris."

Copy link
Contributor

Choose a reason for hiding this comment

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

"Find out what has recently changed in Iris."

I'm in favour of this

docs/iris/src/index.rst Outdated
+++
.. link-button:: iris_whatsnew
:type: ref
:text: What's new
Copy link
Member

Choose a reason for hiding this comment

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

Capital N for consistency with the other buttons?

docs/iris/src/index.rst Outdated
:text: User Guide
:classes: btn-outline-primary btn-block
---
Documentation for the Iris Application Programming Interface.
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure whether API is a familiar term for a lot of our target user-base. Maybe something like "Browse full Iris functionality by module"?

docs/iris/src/index.rst Outdated
:text: Installing Iris
:classes: btn-outline-primary btn-block
---
View the gallery that includes python code used to create it.
Copy link
Member

Choose a reason for hiding this comment

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

How about something like "Example code to create a variety of plots"?

@trexfeathers
Copy link
Contributor

Love it!

@tkknight
Copy link
Contributor Author

Review comments addressed via 0d47a55

@tkknight tkknight mentioned this pull request Sep 28, 2020
Closed
9 tasks
@tkknight
Copy link
Contributor Author

anymore comments? if not could someone please review and approve please.

pp-mo
pp-mo approved these changes Sep 28, 2020
View reviewed changes
Copy link
Member

@pp-mo pp-mo left a comment •
edited
Loading

Choose a reason for hiding this comment

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

A big step forward!

@bjlittle bjlittle self-assigned this Sep 29, 2020
@bjlittle
Copy link
Member

@tkknight Could you just make sure that you've serviced all the reviewer comments, then I'll bank this 👍

@rcomer rcomer merged commit b97d873 into SciTools:master Sep 29, 2020
@rcomer
Copy link
Member

rcomer commented Sep 29, 2020

Think mine were the only comments, so now banked.

tkknight added a commit to tkknight/iris that referenced this pull request Sep 29, 2020
@tkknight
added whats new for pr SciTools#3884
6329c85
@tkknight tkknight mentioned this pull request Sep 29, 2020
Merged
bjlittle pushed a commit that referenced this pull request Sep 29, 2020
@tkknight
added whats new for pr #3884 (#3887)
84dc829 
* added whats new for pr #3884

* added ref for the homepage

* renamed homepage ref
@tkknight tkknight deleted the index_panels branch September 29, 2020 15:39
tkknight added a commit to tkknight/iris that referenced this pull request Oct 8, 2020
@tkknight
Merge remote-tracking branch 'upstream/master' into spelling3
7327011 
* upstream/master:
  add SciTools#3791 whatsnew entry (SciTools#3897)
  bump whatsnew latest and version to 3.1.dev0 (SciTools#3896)
  hide the further topics toc (SciTools#3894)
  Deprecate iris.util.as_compatible_shape (SciTools#3892)
  whatsnew additions (SciTools#3891)
  linkcheck ignore http://cfconventions.org (SciTools#3889)
  Cube arithmetic docs to master (SciTools#3890)
  added whats new for pr SciTools#3884 (SciTools#3887)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rcomer rcomer rcomer left review comments

@trexfeathers trexfeathers trexfeathers left review comments

@pp-mo pp-mo pp-mo approved these changes

Assignees

@bjlittle bjlittle

Labels

Type: Documentation

Projects

None yet

Milestone

v3.0.0

Development

Successfully merging this pull request may close these issues.

API Link

5 participants

@tkknight @pp-mo @trexfeathers @bjlittle @rcomer