Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldbergJoshuaKGoldberg commentedNov 13, 2022•
edited
Loading

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 intoarchitecture/* pages, so they benefit from the richness of the Docusaurus site
  • Removingdocs/ 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 theASTs page to a blog post, with more friendly information and added contextchore: added blog article: 'ASTs and TypeScript-ESLint' #6039
  • MadeCustom Rules,Contributing, andArchitecture top-level entries in the sidebar & navigation
  • SplitIssues andPull Requests into pages underContributing, along with renamingDevelopment toLocal Development
  • A bunch ofnetlify.toml redirects for the old paths
  • Renames files fromUPPER_CASE.md toSentence_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-cloudbot commentedNov 13, 2022•
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit9dd67e6. 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 💌 fromNxCloud.

@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 onhttps://opencollective.com/typescript-eslint.

@netlify
Copy link

netlifybot commentedNov 13, 2022•
edited
Loading

✅ Deploy Preview fortypescript-eslint ready!

NameLink
🔨 Latest commit9a32a5e
🔍 Latest deploy loghttps://app.netlify.com/sites/typescript-eslint/deploys/6378320d8b3e73000b410384
😎 Deploy Previewhttps://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 yourNetlify 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
MemberAuthor

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
MemberAuthor

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...

@JoshuaKGoldbergJoshuaKGoldberg changed the title[WIP] chore: move remaining docs files into websitedocs: move remaining docs files into websiteNov 18, 2022
@JoshuaKGoldbergJoshuaKGoldberg marked this pull request as ready for reviewNovember 19, 2022 01:43
@JoshuaKGoldbergJoshuaKGoldberg changed the base branch frommain toblog-asts-and-typescript-eslintNovember 19, 2022 05:54
Copy link
Member

@bradzacherbradzacher 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!

@bradzacherbradzacher added the 1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we merge labelNov 24, 2022
@JoshuaKGoldbergJoshuaKGoldberg added the documentationDocumentation ("docs") that needs adding/updating labelNov 28, 2022
@JoshuaKGoldbergJoshuaKGoldberg deleted the branchtypescript-eslint:blog-asts-and-typescript-eslintNovember 30, 2022 17:37
@JoshuaKGoldberg
Copy link
MemberAuthor

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

@github-actionsgithub-actionsbot locked asresolvedand limited conversation to collaboratorsDec 8, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account?Sign in.
Reviewers

@bradzacherbradzacherbradzacher approved these changes

@Josh-CenaJosh-CenaAwaiting requested review from Josh-Cena

@JamesHenryJamesHenryAwaiting requested review from JamesHenry

Assignees
No one assigned
Labels
1 approval>=1 team member has approved this PR; we're now leaving it open for more reviews before we mergedocumentationDocumentation ("docs") that needs adding/updating
Projects
None yet
Milestone
No milestone
3 participants
@JoshuaKGoldberg@bradzacher@Josh-Cena
[8]ページ先頭
©2009-2025 Movatter.jp