Skip to content

ci(docs): Update latest symlink via docs-production-deploy workflow#3183

Merged
polarathene merged 1 commit intodocker-mailserver:masterfrom
jrpear:master
Mar 19, 2023
Merged

ci(docs): Update latest symlink via docs-production-deploy workflow#3183
polarathene merged 1 commit intodocker-mailserver:masterfrom
jrpear:master

Conversation

@jrpear
Copy link
Copy Markdown
Contributor

@jrpear jrpear commented Mar 19, 2023 •
edited
Loading

Description

Add another step to the docs-production-deploy workflow to update a latest symlink on gh-pages that points to the latest documentation version.

Begins to fix #3173

Ancillary PR that updates versions.json on gh-pages branch: #3182

If this looks like a good way of maintaining a latest version, I can open a PR with link changes from edge to latest where I think they are warranted.

I've made sure it works on my fork.

Type of change

  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation (README.md or the documentation under docs/)
  • If necessary I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

polarathene
polarathene approved these changes Mar 19, 2023
View reviewed changes
Copy link
Copy Markdown
Member

@polarathene polarathene left a comment

Choose a reason for hiding this comment

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

Thanks for taking time to put this together and verify it working on your own fork 🙏

Awesome work 💪

If this looks like a good way of maintaining a latest version, I can open a PR with link changes from edge to latest where I think they are warranted.

Sounds good 👍

@polarathene polarathene added area/ci kind/improvement Improve an existing feature, configuration file or the documentation area/documentation labels Mar 19, 2023
@polarathene polarathene added this to the v12.0.0 milestone Mar 19, 2023
@polarathene polarathene merged commit d770c67 into docker-mailserver:master Mar 19, 2023
@polarathene polarathene changed the title Add update to latest symlink on gh-pages to docs-production-deploy workflow ci(docs): Update latest symlink via docs-production-deploy workflow Mar 19, 2023
@polarathene
Copy link
Copy Markdown
Member

polarathene commented Mar 19, 2023

Just in case it's not clear, the latest version selector is present in the UI on docs now. But until our docs deploy a new update, there is no symlink presently generated, so it'll 404 for now.

@casperklein
Copy link
Copy Markdown
Member

casperklein commented Mar 19, 2023

  1. Can't this be forced?
  2. Shouldn't we make latest the default instead of edge?

@polarathene
Copy link
Copy Markdown
Member

polarathene commented Mar 19, 2023

Can't this be forced?

The workflow? I think it's triggered by a workflow event only presently.

I was looking into adding some inputs to allow us to invoke a build manually, as one of the docs versions had a bug at the time from the docs generator that prevented links from working. I just didn't get around to finishing that (as per usual 😅 )

I'm not too fussed about forcing it, as soon as docs deploy again it'll be handled.

Shouldn't we make latest the default instead of edge?

That's the approved plan?

See the PR description talking about putting another PR forward if approved, and then in my review I gave the go ahead?

@jrpear jrpear mentioned this pull request Mar 19, 2023
Merged
@jrpear
Copy link
Copy Markdown
Contributor Author

jrpear commented Mar 19, 2023 •
edited
Loading

Just in case it's not clear, the latest version selector is present in the UI on docs now. But until our docs deploy a new update, there is no symlink presently generated, so it'll 404 for now.

Oops, didn't think of that. An easy fix is to just commit a symlink to v11.3 manually. Here's a PR: #3184

@jrpear
Copy link
Copy Markdown
Contributor Author

jrpear commented Mar 19, 2023

Then future pushes of version tags will update the symlink

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

Reviewers

@polarathene polarathene polarathene approved these changes

Assignees

@jrpear jrpear

Labels

area/ci area/documentation kind/improvement Improve an existing feature, configuration file or the documentation

Projects

None yet

Milestone

v12.0.0

Development

Successfully merging this pull request may close these issues.

[FR] Make it easier for people to find the docs for the latest release

3 participants

@jrpear @polarathene @casperklein