Skip to content

docs: move remaining docs files into website #5984

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

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Nov 13, 2022

PR Checklist

Overview

This PR finishes moving most of our documentation onto the site itself. It applies a couple of big changes:

  • Moving README.md contents from packages into architecture/* pages, so they benefit from the richness of the Docusaurus site
  • Removing docs/ from pages, as "docs" is implied by being on the site, and this shortens URLs

It also applies a few cleanups around those changes:

  • Standardized README.md contents for user-facing and internal packages
  • Moved the ASTs page to a blog post, with more friendly information and added context chore: added blog article: 'ASTs and TypeScript-ESLint' #6039
  • Made Custom Rules, Contributing, and Architecture top-level entries in the sidebar & navigation
  • Split Issues and Pull Requests into pages under Contributing, along with renaming Development to Local Development
  • A bunch of netlify.toml redirects for the old paths
  • Renames files from UPPER_CASE.md to Sentence_Case.md (not strictly necessary, I was just tired of the file tree screaming at me)

Sorry that it's such a big PR 🙃 these changes all ended up linking together. But I'm very excited that it should be the last overhaul I do for a while to the docs structure!

@nx-cloud
Copy link

nx-cloud bot commented Nov 13, 2022

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9dd67e6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 24 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint.

@netlify
Copy link

netlify bot commented Nov 13, 2022

Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 9a32a5e
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/6378320d8b3e73000b410384
😎 Deploy Preview https://deploy-preview-5984--typescript-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Comment on lines +12 to +18
[[redirects]]
from = "/docs"
to = "/getting-started"

[[redirects]]
from = "/docs/development/architecture/asts"
to = "/blog/asts-and-typescript-eslint"
Copy link
Member

Choose a reason for hiding this comment

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

FYI, Netlify can use a separate _redirects file (https://docs.netlify.com/routing/redirects/), which IMO is more compact and maintainable

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, that is nicer! Thanks 😄

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh but the .toml version has more options available? Now I'm conflicted...

@JoshuaKGoldberg JoshuaKGoldberg changed the title [WIP] chore: move remaining docs files into website docs: move remaining docs files into website Nov 18, 2022
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review November 19, 2022 01:43
@JoshuaKGoldberg JoshuaKGoldberg changed the base branch from main to blog-asts-and-typescript-eslint November 19, 2022 05:54
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

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

noice - thanks for doing this!
finally website-first!

@bradzacher bradzacher added the 1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge label Nov 24, 2022
@JoshuaKGoldberg JoshuaKGoldberg added the documentation Documentation ("docs") that needs adding/updating label Nov 28, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the branch typescript-eslint:blog-asts-and-typescript-eslint November 30, 2022 17:37
@JoshuaKGoldberg
Copy link
Member Author

🙄 moving to #6138 because GitHub seems to no longer play nicely with chained PRs this way.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
1 approval >=1 team member has approved this PR; we're now leaving it open for more reviews before we merge documentation Documentation ("docs") that needs adding/updating
Projects
None yet
3 participants