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

Configurable end of life notice #4274

Merged
merged 7 commits into from Oct 14, 2019
Merged

Configurable end of life notice #4274

merged 7 commits into from Oct 14, 2019

Conversation

m-kuhn
Copy link
Member

@m-kuhn m-kuhn commented Oct 6, 2019 •
edited

Future proof version of #4273

Adds a new "outdated" option source/conf.py -> html_context
Set that whenever docs are put to the archive to get a nice header bar sending people to the newer version.

image

@m-kuhn m-kuhn changed the title Gameover master Configurable end of life notice Oct 6, 2019
m-kuhn
m-kuhn commented Oct 6, 2019
View reviewed changes
source/conf.py Show resolved Hide resolved
havatv
havatv reviewed Oct 7, 2019
View reviewed changes
Copy link
Contributor

@havatv havatv left a comment

Choose a reason for hiding this comment

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

Looks fine to me. I have a suggestion (just for a comment)

source/conf.py Show resolved Hide resolved
@DelazJ
Copy link
Collaborator

DelazJ commented Oct 7, 2019

I love it. Thanks @m-kuhn
Could we imagine we also use this kind of feature to indicate we're in testing docs? ie, something to replace the |updatedisclaimer| we have on top of each file (and that we have to remove at each new branching because unable to find how to deactivate that rst_prolog directive)?

@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 14, 2019

Could we imagine we also use this kind of feature to indicate we're in testing docs

Probably yes. I think this PR should serve as a good example for anyone to tackle this.

DelazJ
DelazJ reviewed Oct 14, 2019
View reviewed changes
Copy link
Collaborator

@DelazJ DelazJ left a comment

Choose a reason for hiding this comment

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

Probably yes. I think this PR should serve as a good example for anyone to tackle this.

Thanks @m-kuhn. My intent was not to suggest you to do it. You already show the path and from what I understand Alexandre will give it a try. I was only seeking if it'd make sense.

source/conf.py Outdated Show resolved Hide resolved
themes/qgis-theme/layout.html Outdated Show resolved Hide resolved
m-kuhn and others added 2 commits October 14, 2019 11:20
@m-kuhn @DelazJ
Remove copy-paste leftover
91db709 
Co-Authored-By: Harrissou Sant-anna <delazj@gmail.com>
@m-kuhn @DelazJ
Update link to point to live docs
ef7fbb1 
Co-Authored-By: Harrissou Sant-anna <delazj@gmail.com>
@m-kuhn m-kuhn mentioned this pull request Oct 14, 2019
Merged
1 task
@SrNetoChan
Copy link
Member

Oh, I missed the fact there was two different PRs. I will definitely try to reuse this.

@m-kuhn m-kuhn merged commit 9518ba9 into qgis:master Oct 14, 2019
@m-kuhn m-kuhn deleted the gameover_master branch October 14, 2019 13:49
@backporting backporting bot mentioned this pull request Oct 14, 2019
Merged
@SrNetoChan SrNetoChan mentioned this pull request Oct 14, 2019
Closed
@jef-n
Copy link
Member

jef-n commented Oct 15, 2019

Too avoid the rebuild of all the old docs. I've put a (not as good looking) mod_substitute rule in place that inserts a warning with a link into the older copies.

                Substitute "s|<body>|<body><div align=\"center\"><h3>Outdated version of the documentation.  Find the latest one <a href=\"/3.4/\">here</a>.</h3></div>|"

@DelazJ
Copy link
Collaborator

DelazJ commented Oct 15, 2019

Indeed, not so good looking... BUT pretty visible
Can we use the link to latest instead of 3.4 to avoid maintenance here?

@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 15, 2019

Isn't it easy enough to rebuild?

@anitagraser
Copy link
Member

anitagraser commented Oct 18, 2019 •
edited

@m-kuhn nice work! Is your version of the notice also visible when scrolling down? Jürgen's version unfortunately vanishes behind the top black bar

image

@Gustry
Copy link
Contributor

Gustry commented Oct 18, 2019

I just tried to visit https://docs.qgis.org/2.18/en/docs/
Thanks for taking care of this issue.

I think we really need some orange warning. I saw some colors on @m-kuhn screenshot, but there isn't anymore. Is-there any reason? Even if it's big font, it's not very obvious

@elpaso
Copy link
Contributor

elpaso commented Oct 18, 2019 via email

@SrNetoChan
Copy link
Member

I like that warning!

@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 18, 2019

Yes, it sticks to the top when scrolling (and has color as visible in the first screenshot on top of this page)

@jef-n
Copy link
Member

jef-n commented Oct 18, 2019

warning it is - and it's also pointing to latest/ now.

@jef-n
Copy link
Member

jef-n commented Oct 18, 2019 •
edited

Isn't it easy enough to rebuild?

Not as easy at least.

@DelazJ DelazJ mentioned this pull request Oct 20, 2019
Merged
@m-kuhn
Copy link
Member Author

m-kuhn commented Oct 23, 2019

I was able to build it locally, I just don't know where I would need to upload it to.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@havatv havatv havatv left review comments

@DelazJ DelazJ DelazJ left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@m-kuhn @DelazJ @SrNetoChan @jef-n @anitagraser @Gustry @elpaso @havatv