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

docs: move whatsnew #4540

Merged
merged 3 commits into from
Jan 31, 2022
Merged

Conversation

bjlittle
Copy link
Member

@bjlittle bjlittle commented Jan 26, 2022

🚀 Pull Request

Description

This PR moves the What's New in Iris documentation menu item to a move prevalent position i.e., from buried within the lower Reference section up into its own What's New in Iris section at the top of the LHS menu panel.

This make it a wee bit more obvious for the reader to find and access.

Also, as a convenience, this PR also includes a one-click hit that takes the reader to the latest development or stable documentation on RTD, or an archive of all the (dev and stable) doc versions.

A rendered version of the documentation is available here to view e.g.,
image


Consult Iris pull request check list

@bjlittle bjlittle force-pushed the docs-move-whatsnew-menu branch 2 times, most recently from 89e47cc to 46595e1 Compare January 28, 2022 07:32
@bjlittle
Copy link
Member Author

bjlittle commented Jan 28, 2022

@SciTools/iris-devs If we're going to commit to this then I'd recommend that we do so as the last PR on main before cutting the v3.2.x release feature branch.

This'll make the v3.2.x merge back less painful, and we're not delaying the inevitable rebase/merge conflicts that everyone will encounter.

Thoughts? 🤔

@rcomer
Copy link
Member

rcomer commented Jan 28, 2022

Less scrolling and less clicking sounds like a win to me.

@bjlittle bjlittle force-pushed the docs-move-whatsnew-menu branch 2 times, most recently from b6eb8fa to 35334b1 Compare January 28, 2022 16:22
@lbdreyer lbdreyer mentioned this pull request Jan 28, 2022
@bjlittle bjlittle force-pushed the docs-move-whatsnew-menu branch from 35334b1 to 555992f Compare January 29, 2022 15:25
@bjlittle bjlittle force-pushed the docs-move-whatsnew-menu branch from 555992f to 49259f1 Compare January 31, 2022 11:24
Copy link
Member

@lbdreyer lbdreyer left a comment

Choose a reason for hiding this comment

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

Thanks @bjlittle !

@lbdreyer lbdreyer merged commit 3cbb687 into SciTools:main Jan 31, 2022
@bjlittle bjlittle deleted the docs-move-whatsnew-menu branch February 18, 2022 09:26
tkknight added a commit to tkknight/iris that referenced this pull request Mar 16, 2022
* main: (64 commits)
  [pre-commit.ci] pre-commit autoupdate (SciTools#4587)
  fix test (SciTools#4585)
  Loading Benchmarks (SciTools#4477)
  Fix refresh lockfile worrkflow pull request title (SciTools#4579)
  gha: lockfiles labels and auto-pr details (SciTools#4578)
  Bump actions/script from 4 to 5.1.0 (SciTools#4576)
  Bump actions/stale from 4.0.0 to 4.1.0 (SciTools#4575)
  Bump peter-evans/create-pull-request from 3.8.2 to 3.12.1 (SciTools#4577)
  adopt dependabot GHA (SciTools#4568)
  New tool-agnostic ASV environment management (SciTools#4571)
  Updated environment lockfiles (SciTools#4567)
  Update version to 3.3.dev0 (SciTools#4565)
  Reset whats new (SciTools#4563)
  docs: move whatsnew (SciTools#4540)
  Deprecate regrids (SciTools#4548)
  Update latest.rst (SciTools#4556)
  Updated environment lockfiles (SciTools#4555)
  Added whatsnew for SciTools#4551. (SciTools#4553)
  Update SciTools#4505 doctests for SciTools#4528. (SciTools#4554)
  minor optimisations (SciTools#4549)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants