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

chore: Add static frontmatter to docs #15782

Merged
merged 10 commits into from Apr 22, 2022
Merged

chore: Add static frontmatter to docs #15782

merged 10 commits into from Apr 22, 2022

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented Apr 13, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

This adds YAML frontmatter to all of our documentation files and removes all of the inline titles from the pages in preparation for the new docs site. I also updated the Makefile to no longer add in the frontmatter.

There will be a corresponding change in the website to consume this format of documentation:
eslint/archive-website#933

We should be sure to merge the website one first and then this one, just to be safe.

Is there anything you'd like reviewers to focus on?

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon chore This change is not user-facing labels Apr 13, 2022
Makefile.js Outdated Show resolved Hide resolved
Makefile.js Outdated Show resolved Hide resolved
nzakas and others added 4 commits April 15, 2022 12:53
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@mdjermanovic
Copy link
Member

These files still have unnecessary ## Resources section:

rules/global-strict.md
rules/no-arrow-condition.md
rules/no-comma-dangle.md
rules/no-empty-class.md
rules/no-empty-label.md
rules/no-extra-strict.md
rules/no-reserved-keys.md
rules/no-space-before-semi.md
rules/no-wrap-func.md
rules/space-after-function-name.md
rules/space-after-keywords.md
rules/space-before-function-parentheses.md
rules/space-before-keywords.md
rules/space-in-brackets.md
rules/space-return-throw-case.md
rules/space-unary-word-ops.md
rules/spaced-line-comment.md

Copy link
Member

@btmills btmills left a comment

Choose a reason for hiding this comment

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

I've gone through all the non-rule docs so far. Will continue with makefile and rules later.

docs/src/pages/index.md Outdated Show resolved Hide resolved
docs/src/maintainer-guide/npm-2fa.md Outdated Show resolved Hide resolved
nzakas and others added 2 commits April 18, 2022 17:21
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
@nzakas
Copy link
Member Author

nzakas commented Apr 20, 2022

Okay, I think I got everything now. 👍

Copy link
Member

@btmills btmills left a comment

Choose a reason for hiding this comment

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

Two questions, but depending on the answers this could be merged as-is.

docs/src/rules/global-strict.md Show resolved Hide resolved
Makefile.js Show resolved Hide resolved
Copy link
Member

@mdjermanovic mdjermanovic left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@mdjermanovic mdjermanovic merged commit db28f2c into main Apr 22, 2022
@mdjermanovic mdjermanovic deleted the docs-fm branch April 22, 2022 11:40
@aladdin-add
Copy link
Member

looks like removing the .md had broken github links. I've got many 404s when browser the docs. 😂

@btmills
Copy link
Member

btmills commented Apr 25, 2022

Yikes, that’s not good. Will you share some examples? I’m not having any issues following a sample of links that were changed in this PR.

@aladdin-add
Copy link
Member

aladdin-add commented Apr 25, 2022

an example: https://github.com/eslint/eslint/blob/8ae177229163bb61397ee31fb8ed4c826e73ee2e/docs/src/developer-guide/README.md#section-1-get-the-source-code

the sourcecode link is broken, as we removed .md:

- ## Section 1: Get the [Source Code](source-code.md)
+ ## Section 1: Get the [Source Code](source-code)

crapStone pushed a commit to Calciumdibromid/CaBr2 that referenced this pull request Apr 25, 2022
This PR contains the following updates:

| Package | Type | Update | Change |
|---|---|---|---|
| [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.13.0` -> `8.14.0`](https://renovatebot.com/diffs/npm/eslint/8.13.0/8.14.0) |

---

### Release Notes

<details>
<summary>eslint/eslint</summary>

### [`v8.14.0`](https://github.com/eslint/eslint/releases/v8.14.0)

[Compare Source](eslint/eslint@v8.13.0...v8.14.0)

#### Features

-   [`ab6363d`](eslint/eslint@ab6363d) feat: Add rule no-constant-binary-expression ([#&#8203;15296](eslint/eslint#15296)) (Jordan Eldredge)

#### Bug Fixes

-   [`35fa1dd`](eslint/eslint@35fa1dd) fix: allow project paths to have URL-encoded characters ([#&#8203;15795](eslint/eslint#15795)) (Milos Djermanovic)
-   [`413f1d5`](eslint/eslint@413f1d5) fix: update `astUtils.isDirectiveComment` with `globals` and `exported` ([#&#8203;15775](eslint/eslint#15775)) (Milos Djermanovic)

#### Build Related

-   [`c2407e8`](eslint/eslint@c2407e8) build: add node v18 ([#&#8203;15791](eslint/eslint#15791)) (唯然)

#### Chores

-   [`735458c`](eslint/eslint@735458c) chore: add static frontmatter to no-constant-binary-expression docs ([#&#8203;15798](eslint/eslint#15798)) (Milos Djermanovic)
-   [`db28f2c`](eslint/eslint@db28f2c) chore: Add static frontmatter to docs ([#&#8203;15782](eslint/eslint#15782)) (Nicholas C. Zakas)
-   [`3bca59e`](eslint/eslint@3bca59e) chore: markdownlint autofix on commit ([#&#8203;15783](eslint/eslint#15783)) (Nicholas C. Zakas)

</details>

---

### Configuration

📅 **Schedule**: At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox.

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

Co-authored-by: cabr2-bot <cabr2.help@gmail.com>
Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1318
Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org>
Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
@btmills
Copy link
Member

btmills commented May 7, 2022

Ah you mean while browsing the docs via GitHub's code explorer instead of on https://eslint.org/docs? I imagine that's a tradeoff we're okay with. Otherwise we'd have to implement a translation step during site build.

@aladdin-add
Copy link
Member

aladdin-add commented May 7, 2022

yes, I was using github. just speaking out in case it is an inadvertent change. 😄

srijan-deepsource pushed a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
* chore: Add static frontmatter to docs

* cleanup architecture docs location

* Update rule ID check for docs

* Update lint check

* Update Makefile.js

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* Cleanup based on feedback

* Fix Makefile.js gensite

* Revert "Fix Makefile.js gensite"

This reverts commit 822dc55.

* Update docs/src/pages/index.md

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

* Remove extra file and resources sections

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
srijan-deepsource added a commit to DeepSourceCorp/eslint that referenced this pull request May 30, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Oct 20, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Oct 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion chore This change is not user-facing triage An ESLint team member will look at this issue soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants