Skip to content

Conversation

@yaauie
Copy link
Contributor

@yaauie yaauie commented Nov 19, 2022

Release notes

[rn:skip]

What does this PR do?

Fixes the docs build.

TIL that [source] blocks are handled as subdocuments in asciidoc, and their ability to link to the outer doc that contains them is implementation-specific. While my local docs tools can resolve the references, the docs build was broken by them 😩

Why is it important/What is the impact to the user?

It removes a broken thing from the docs used by the combined LS docs build.

We will need to mutate the tag held in github for the versioned plugin reference to pick up this fix since it is sourcing from rubygems version number (which is less than ideal), but with net zero code changes on this pre-1.0 project I am comfortable with the ramifications.

Once merged, we will need to push a tag deletion to github:

git push --delete origin v0.1.0 

And then this will need to be re-tagged (preferably including a cryptographic signature).

git fetch origin git checkout ${PR_MERGE_COMMIT} git tag -s v0.10 git push origin v0.1.0 
Copy link
Contributor

@karenzone karenzone 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 the fix to source.

@karenzone
Copy link
Contributor

@yaauie, thanks for the fix. Merging so that correct formatting is safely in place in plugin source.

Because this is a docs-only change in a pre-release version, I don't believe that the above gymnastics are necessary. Let's discuss.

@karenzone karenzone merged commit 3cb58e5 into logstash-plugins:main Nov 30, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants