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(release-notes): fix up version header #8941

Merged
merged 1 commit into from
Apr 12, 2024

Conversation

cpcloud
Copy link
Member

@cpcloud cpcloud commented Apr 11, 2024

Add permalinks to release notes versions.

Fixes #8624.

@cpcloud cpcloud added this to the 9.0 milestone Apr 11, 2024
@cpcloud cpcloud added the docs Documentation related issues or PRs label Apr 11, 2024
@cpcloud cpcloud force-pushed the fix-version-headers-quarto branch 2 times, most recently from a3b0918 to 50142c4 Compare April 11, 2024 16:08
@cpcloud
Copy link
Member Author

cpcloud commented Apr 11, 2024

Not a huge fan of having to write Lua to do this, but c'est la vie.

@cpcloud cpcloud added the docs-preview Add this label to trigger a docs preview label Apr 12, 2024
@ibis-docs-bot ibis-docs-bot bot removed the docs-preview Add this label to trigger a docs preview label Apr 12, 2024
@ibis-docs-bot
Copy link

ibis-docs-bot bot commented Apr 12, 2024

@cpcloud cpcloud enabled auto-merge (squash) April 12, 2024 11:13
@cpcloud cpcloud disabled auto-merge April 12, 2024 11:21
@cpcloud cpcloud merged commit e583d2b into ibis-project:main Apr 12, 2024
97 checks passed
@cpcloud cpcloud deleted the fix-version-headers-quarto branch April 12, 2024 11:21
@amoeba
Copy link
Contributor

amoeba commented Apr 12, 2024

Hey @cpcloud, following quarto-dev/quarto#413, this seems to work for me locally, in case that would work here:

diff --git a/docs/release_notes.md b/docs/release_notes.md
index f8def1134..e28af30ea 100644
--- a/docs/release_notes.md
+++ b/docs/release_notes.md
@@ -1,7 +1,7 @@
 Release notes
 ---

-## [8.0.0](https://github.com/ibis-project/ibis/compare/7.2.0...8.0.0) (2024-02-05)
+## [8.0.0](https://github.com/ibis-project/ibis/compare/7.2.0...8.0.0) (2024-02-05) {#8.0.0}


 ### ⚠ BREAKING CHANGES

@cpcloud
Copy link
Member Author

cpcloud commented Apr 12, 2024

It might, but the automation around release notes makes it probably roughly the same amount of work as what we currently have

@cderv
Copy link

cderv commented Apr 12, 2024

@amoeba yes this is indeed (bad?) Pandoc default for auto identifier for section that does not have explicit and don't start with letter.
Not that # v8.0.0 would correctly get you id="v8.0.0" on the HTML - any header starting with a letter first really.

but probably not what you want here. I'm sharing just in case changing headers would be worth making to prevent special processing.

@amoeba
Copy link
Contributor

amoeba commented Apr 12, 2024

Right, thanks for pointing that out @cderv. Pandoc is probably saving users from some awful edge cases elsewhere else.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: Make links to sections in release notes stable across releases
3 participants