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

do not commit generated content to VCS; closes #3713 #4289

Merged
merged 2 commits into from
May 18, 2020

Conversation

boneskull
Copy link
Contributor

This removes markdown-magic and replaces its functionality with the built-in data capabilities of 11ty.

The TOC, --help output, and source files are now all done via global data scripts in docs/_data.

When building documentation, we will no longer get changes to e.g., docs/index.md because of the automatically generated content.

@boneskull boneskull added semver-patch implementation requires increase of "patch" version number; "bug fixes" area: website involving mochajs.org, but not necessarily involving docs labels May 15, 2020
@boneskull boneskull requested a review from Munter May 15, 2020 22:28
@boneskull boneskull self-assigned this May 15, 2020
@coveralls
Copy link

coveralls commented May 15, 2020

Coverage Status

Coverage remained the same at 93.228% when pulling 4d7e86e on boneskull/issue/3713 into 68eec9e on master.

Copy link
Contributor

@Munter Munter left a comment

Choose a reason for hiding this comment

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

This a great addition. I was always a bit weirded out by the auto generation inside version controlled files

This removes `markdown-magic` and replaces its functionality with the built-in data capabilities of 11ty.

The TOC, `--help` output, and source files are now all done via global data scripts in `docs/_data`.

When building documentation, we will no longer get changes to e.g., `docs/index.md` because of the automatically generated content.
Usage of the words as defined in options will result in a warning, and will not break the build.

Also: Eleventy should ignore the historical changelogs in `docs/changelogs`.
@boneskull
Copy link
Contributor Author

I added an official eleventy plugin which detects usages of words like "simply", "obviously", etc., which don't only make the reader feel stupid, but are often straight-up bad writing 😄

It emits warnings at build time and will not break the build.

@boneskull
Copy link
Contributor Author

I've confirmed the build has passed for real with my eyeballs, so merging

@boneskull boneskull merged commit ca0daa3 into master May 18, 2020
@boneskull boneskull deleted the boneskull/issue/3713 branch May 18, 2020 21:27
@craigtaub craigtaub added this to the next milestone May 21, 2020
craigtaub pushed a commit that referenced this pull request May 21, 2020
* do not commit generated content to VCS

This removes `markdown-magic` and replaces its functionality with the built-in data capabilities of 11ty.

The TOC, `--help` output, and source files are now all done via global data scripts in `docs/_data`.

When building documentation, we will no longer get changes to e.g., `docs/index.md` because of the automatically generated content.

* add inclusive language plugin to eleventy

Usage of the words as defined in options will result in a warning, and will not break the build.

Also: Eleventy should ignore the historical changelogs in `docs/changelogs`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: website involving mochajs.org, but not necessarily involving docs semver-patch implementation requires increase of "patch" version number; "bug fixes"
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants