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

Implement Asciidoctor macros for release notes documents #1082

Open
joaquintides opened this issue Jun 2, 2024 · 2 comments
Open

Implement Asciidoctor macros for release notes documents #1082

joaquintides opened this issue Jun 2, 2024 · 2 comments
Assignees
Labels
Feature New feature or request

Comments

@joaquintides
Copy link
Member

joaquintides commented Jun 2, 2024

This is connected with the new release notes procedure. The current qbk-based mechanism for release notes production makes available some "macros" defined here:

https://github.com/boostorg/website/blob/master/feed/ext.qbk

Many of these macros are not in actual use in the release notes (meaning I haven't seen them used recently or ever). The ones that I've seen are (see the latest qbk-based release notes and the generated output):

  • [phrase library..XX]: produces a header for the section on lib X.
  • [@/libs/function/ Function] creates a link to the docs for the library (Function in the example). I understand that
  • [github_pr geometry 1247]: produces this: PR#1247
  • [github geometry 1231]: produces this: #1231
  • [@/tools/build/ Build]: I think this is formally equivalent to [@/libs/function/ Function].

We need to have equivalent Asciidoc macros for the benefit of Boost authors contributing their individual notes in the new release notes procedure.

@kennethreitz kennethreitz added the Feature New feature or request label Jun 20, 2024
@kennethreitz kennethreitz moved this to In Progress in website-v2 Jun 20, 2024
@kennethreitz kennethreitz removed the status in website-v2 Jun 20, 2024
@joaquintides joaquintides moved this to On hold in website-v2 Aug 8, 2024
@daveoconnor daveoconnor moved this from Blocked to In Progress in website-v2 Oct 11, 2024
@daveoconnor daveoconnor moved this from In Progress to In Review in website-v2 Oct 23, 2024
@daveoconnor
Copy link
Collaborator

@sdarwin and @pdimov for this ticket I'll need a new repo e.g. asciidoctor-boost and an account on rubygems for providing a distributable package.

It probably makes more sense that that rubygems account be tied to the c++ alliance/boost than me, and Rob suggested you'd be the people to talk to about that. Can you help?

@sdarwin
Copy link
Collaborator

sdarwin commented Oct 30, 2024

daveoconnor added a commit that referenced this issue Nov 8, 2024
Related to ticket #1082, this adds support for asciidoc macros to
emulate macros from qbk. Macro support is documented at https://github.com/cppalliance/asciidoctor-boost/
@daveoconnor daveoconnor moved this from In Review to Done in website-v2 Nov 8, 2024
GregKaleka pushed a commit that referenced this issue Nov 14, 2024
Related to ticket #1082, this adds support for asciidoc macros to
emulate macros from qbk. Macro support is documented at https://github.com/cppalliance/asciidoctor-boost/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request
Projects
Status: Done
Development

No branches or pull requests

4 participants