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

Remove extra space to fix broken doc versioned plugin reference build #347

Merged
merged 2 commits into from
Jul 26, 2018

Conversation

dedemorton
Copy link
Contributor

The extra space in the link was causing problems with the versioned plugin reference build because the cleanup part of the script was unable to make the necessary replacement: https://github.com/elastic/docs-tools/blob/master/versioned_plugins.rb#L224

Copy link
Contributor

@robbavey robbavey left a comment

Choose a reason for hiding this comment

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

Would you mind fixing up the changelog entry? We are trying to introduce some consistency into how we format our changelog entries

CHANGELOG.md Outdated
@@ -1,3 +1,6 @@
## 5.1.6
- Docs: Fix broken link by removing extra space.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you mind changing this to use the format described in the logstash plugin contribution guidelines for writing changelogs?

@dedemorton
Copy link
Contributor Author

@robbavey Is this what you had in mind? 29ff0bc

@robbavey
Copy link
Contributor

@dedemorton I think that should be ok - the general guidelines are to start with 'Fixed/Added/Changed' etc, but I don't necessarily think that prepending an entry with Docs: is an issue

@dedemorton
Copy link
Contributor Author

@robbavey I'd be happy to reevaluate, but I think flagging the issue as doc-related helps people skip over changes that are mostly superficial. We could use [Docs] instead of Docs: to make it look more consistent in the changelog? I don't have a strong preference, but I do think it's worth flagging doc-only changes.

@dedemorton dedemorton merged commit bbff09f into logstash-plugins:master Jul 26, 2018
@dedemorton dedemorton deleted the remove_extra_space branch July 26, 2018 16:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants