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: Mark `collection_dir` as unreleased #6412

Merged
merged 1 commit into from Oct 4, 2017

Conversation

Projects
None yet
5 participants
@DirtyF
Member

DirtyF commented Oct 4, 2017

Following #6408

Our Style Guide provide has a specific note type for unreleased features, let us make use of it.

collection_dir-unreleased

Unreleased notes are not meant to embed entire code snippets, but that's OK the feature is still understandable.

@DirtyF DirtyF requested a review from jekyll/documentation Oct 4, 2017

@DirtyF DirtyF added the documentation label Oct 4, 2017

@ashmaroli

This comment has been minimized.

Member

ashmaroli commented Oct 4, 2017

Cool! Always wondered if that style was ever used..
What happens when v3.7.0 is released? Does JekyllBot remind you to make the switch once again or do you keep tabs manually?

@pathawks

This comment has been minimized.

Member

pathawks commented Oct 4, 2017

What happens when v3.7.0 is released?

Users running older versions of Jekyll will see that theyneed to upgrade to use this feature👍

@DirtyF

This comment has been minimized.

Member

DirtyF commented Oct 4, 2017

Does JekyllBot remind you to make the switch once again or do you keep tabs manually?

It's all manual for now.

When we create the issue for a release, we should always check that new features are properly documented. Ideally, we specifically ask for it in the CONTRIBUTING template, the same way we ask to add tests. At least we make sure all new features are documented by their authors.

I'm not sure what to automate here, but it should be a blocker before merging a feature.

@ashmaroli

This comment has been minimized.

Member

ashmaroli commented Oct 4, 2017

I'm not sure what to automate here

The "golden_box" represents a note on an unreleased feature. When the said version is released, the "golden-box" becomes a misnomer..
So in an ideal universe, JekyllBot steps in and creates an issue reminding the maintainers about the discrepancy..

@ashmaroli

This comment has been minimized.

Member

ashmaroli commented Oct 4, 2017

I'm not saying it needs to be so.. was only wondering aloud.. 😉

@lsrdg

That's great! I was about to open issue, but you solved it first.

@DirtyF

This comment has been minimized.

Member

DirtyF commented Oct 4, 2017

@jekyllbot: merge +docs

@jekyllbot jekyllbot merged commit 1d29f50 into master Oct 4, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@jekyllbot jekyllbot deleted the docs/collection_dir-unreleased branch Oct 4, 2017

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