Document that _drafts need to be contained within the custom collection directory

[localheinz]

This PR

• adjusts the note about moving the _posts directory into the custom collection directory to also move the _drafts directory

Follows #6680.

💁‍♂️ Tripped over this, apparently tests for it exist, see

jekyll/features/collections_dir.feature

Lines 67 to 161 in 41fa9cd

	Scenario: Rendered collection in custom collections_dir also containing drafts
	Given I have a collections/_puppies directory
	And I have the following document under the "puppies" collection within the "collections" directory:
	| title | date | content |
	| Rover | 2007-12-31 | content for Rover. |
	And I have a collections/_drafts directory
	And I have the following draft within the "collections" directory:
	| title | date | content |
	| Gathered Draft | 2009-03-27 | Random Content. |
	And I have a "_config.yml" file with content:
	"""
	collections:
	puppies:
	output: true
	collections_dir: collections
	"""
	When I run jekyll build --drafts
	Then I should get a zero exit status
	And the _site directory should exist
	And the "_site/puppies/rover.html" file should exist
	And I should see "Random Content." in "_site/2009/03/27/gathered-draft.html"
	And the _site/collections directory should not exist
	Scenario: Rendered collection in custom collections_dir with drafts at the site root
	Given I have a collections/_puppies directory
	And I have the following document under the "puppies" collection within the "collections" directory:
	| title | date | content |
	| Rover | 2007-12-31 | content for Rover. |
	And I have a _drafts directory
	And I have the following draft:
	| title | date | content |
	| Draft At Root | 2009-03-27 | Random Content. |
	And I have a "_config.yml" file with content:
	"""
	collections:
	puppies:
	output: true
	collections_dir: collections
	"""
	When I run jekyll build --drafts
	Then I should get a zero exit status
	And the _site directory should exist
	And the "_site/puppies/rover.html" file should exist
	And the "_site/2009/03/27/draft-at-root.html" file should not exist
	Scenario: A complex site with collections posts and drafts at various locations
	Given I have a gathering/_puppies directory
	And I have a gathering/_posts directory
	And I have a gathering/_drafts directory
	And I have a _puppies directory
	And I have a _posts directory
	And I have a _drafts directory
	And I have the following document under the "puppies" collection within the "gathering" directory:
	| title | date | content |
	| Rover in Gathering | 2007-12-31 | content for Rover. |
	And I have the following document under the puppies collection:
	| title | date | content |
	| Rover At Root | 2007-12-31 | content for Rover. |
	And I have the following post within the "gathering" directory:
	| title | date | content |
	| Post in Gathering | 2009-03-27 | Totally nothing. |
	And I have the following post:
	| title | date | content |
	| Post At Root | 2009-03-27 | Totally nothing. |
	And I have the following draft within the "gathering" directory:
	| title | date | content |
	| Draft In Gathering | 2009-03-27 | This is a draft. |
	And I have the following draft:
	| title | date | content |
	| Draft At Root | 2009-03-27 | This is a draft. |
	And I have a "_config.yml" file with content:
	"""
	collections:
	puppies:
	output: true
	collections_dir: gathering
	"""
	And I have a "gathering/_puppies/static_file.txt" file that contains "Static content."
	And I have a gathering/_puppies/nested directory
	And I have a "gathering/_puppies/nested/static_file.txt" file that contains "Nested Static content."
	When I run jekyll build --drafts
	Then I should get a zero exit status
	And the _site directory should exist
	And the "_site/puppies/rover-in-gathering.html" file should exist
	And the "_site/2009/03/27/post-in-gathering.html" file should exist
	And the "_site/2009/03/27/draft-in-gathering.html" file should exist
	And the "_site/2009/03/27/draft-at-root.html" file should not exist
	And the "_site/puppies/rover-at-root.html" file should not exist
	And I should see exactly "Static content." in "_site/puppies/static_file.txt"
	And I should see exactly "Nested Static content." in "_site/puppies/nested/static_file.txt"
	And the _site/gathering directory should not exist
	And the _site/_posts directory should not exist

[localheinz]

Does this even make sense?

Still doing baby steps in Ruby, apologies when I'm doing it wrong.

🤓

[ashmaroli]

What is the desired output here?

Please move '_drafts, _posts' into the custom directory at..

[localheinz]

I think it should be

Please move '_drafts', '_posts' into the custom directory at..

but only if both _drafts and _posts where detected outside the custom collections directory.

Am I doing it wrong? I thought it would be better to combine this into single messages, rather than rendering the same message with different directories. What do you think, @ashmaroli?

[ashmaroli]

To discover (and learn Ruby along the way) the output to your code, you try simple code in your terminal itself..

• In you terminal, run irb
• Then execute ["_drafts", "_posts"].join("', '") and see how the output looks like..

[ashmaroli]

Testing for _posts and _drafts separately is the best solution. For that create a new method for _drafts and then extract the common steps between the two into a private helper method..

[ashmaroli]

@localheinz The maintainers may not release a v3.8.2 with this patch.. So it would be better for the community if you would open a new PR for just fixing the documentation which will go live as soon as that PR is merged..

[localheinz]

@ashmaroli

Thank you for your feedback! Pulled out the changes to the doctor command into a separate pull request, see #6986.

[DirtyF]

@jekyllbot: merge +docs