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

Update the website with versioned docs #5187

Merged
merged 1 commit into from Aug 6, 2022

Conversation

cortinico
Copy link
Member

Fixes #4168

There is not much to review here, other than keeping a look at the website from the preview and make sure no link got broken (that is likely if we were using relative paths around).

By default, users on the website will see the "current" docs which are the latest released version (1.21.0 in this case). Users can switch to "next" to see the current status of the documentation.

@github-actions
Copy link

github-actions bot commented Aug 5, 2022

Warnings
⚠️ This PR is approved with no milestone set. If merged, it won't appear in the Detekt release notes.
Messages
📖

Thank you very much for making our website better ❤️!

Generated by 🚫 dangerJS against 9b4fd82

@@ -0,0 +1,3 @@
[
"1.21.0"
Copy link
Member

Choose a reason for hiding this comment

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

Is there any implication of this for the release process? e.g. need to update a script where instead of just regenerating, you would need to make a copy-paste of the current stuff for backup or future use?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yup we'll have to call yarn run docusaurus docs:version <VERSION_NUMBER> while cutting the branch.

@cortinico
Copy link
Member Author

The only thing that I'm unsure are the snippets where we have [detekt_version] in the source code. It might be that the version is resolved once for the whole website, so once we release 1.22.0, users on 1.21.0 will see the snippets with the old version.

I'll address this if it's the case in the future.

@cortinico cortinico merged commit 6061f29 into detekt:main Aug 6, 2022
@marschwar
Copy link
Contributor

Is it now safe to revert the revert of #5160 @cortinico ?

@cortinico
Copy link
Member Author

Is it now safe to revert the revert of #5160 @cortinico ?

Yes those files are untouched 👍

@cortinico
Copy link
Member Author

Is it now safe to revert the revert of #5160 @cortinico ?

Heads up: this was never unreverted and is now missing. @marschwar can we re-apply it?

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

Successfully merging this pull request may close these issues.

Move to versioned documentation
4 participants