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.

Sign up for GitHub

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

Jump to bottom

plan for hosting linter documentation post repo-move #4460

Closed
Tracked by #4411
pq opened this issue Jun 14, 2023 · 5 comments
Closed
Tracked by #4411

plan for hosting linter documentation post repo-move #4460

pq opened this issue Jun 14, 2023 · 5 comments
Labels
P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation

Comments

@pq
Copy link
Member

pq commented Jun 14, 2023 •
edited
Loading

@parlough: would you mind spitballing some of your ideas for post-repo move doc-hosting?
@pq pq mentioned this issue Jun 14, 2023
Closed
12 tasks
@pq pq added type-documentation A request to add or improve documentation P2 A bug or feature request we're likely to work on labels Jun 14, 2023
@pq pq changed the title a plan for hosting linter documentation moving forward plan for hosting linter documentation post repo-move Jun 14, 2023
@parlough
Copy link
Member

parlough commented Jun 17, 2023 •
edited
Loading

In the short term, before we update and introduce split diagnostic and discovery docs, or whatever that will entail, my plan is loosely as follows:

@parlough parlough mentioned this issue Jun 17, 2023
Merged
@parlough
Copy link
Member

At least in the short term, the generated document that remains useful for dart.dev, package:lints, and perhaps elsewhere is the rules.json. Perhaps we can move this in tree and have a test that makes sure it is up to date?

parlough added a commit to dart-lang/site-www that referenced this issue Jun 27, 2023
@parlough
Implement individual linter rule pages (#4999)
2faf0e4 
This PR is meant to finalize work to make dart.dev a satisfactory
replacement for
[`dart-lang.github.io/linter/`](https://dart-lang.github.io/linter/)
while `dart-lang/linter` moves to the SDK and we work on consolidating
and improving documentation
(#4498).

It does this by (staged links after colon (`:`)):

- Updating the information on dart.dev/lints for the latest state of the
linter:
[/lints](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/tools/linter-rules)
- Making dart.dev/lints an index page rather than including all
information:
[/lints](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/tools/linter-rules)
- Moving the long-form lint rule documentation to individual pages found
at `dart.dev/lints/<rule>`:
[/lints/avoid_dynamic_calls](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/lints/avoid_dynamic_calls)
- It does this by using a Jekyll page generator based on
`linter_rules.json`.
- Adding a textual reference pointing to the recently released all
linter rules page
(38973de)
found at:
[/lints/all](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/lints/all)
- Updating and links and references for these previous changes (mostly
Effective Dart).

Contributes to dart-lang/linter#4460,
#4498,
#4499

**Note:** This is an intermediate step and doesn't aim to improve the
formatting or style of the information on the index or individual pages.
That will be part of follow-up work as we work on improvements to the
diagnostic linter rule documentation.
This was referenced Jun 28, 2023
Merged
Merged
Merged
Merged
Merged
Merged
auto-submit bot pushed a commit to flutter/packages that referenced this issue Jun 28, 2023
@parlough
[various] Update links to the old linter site to point to dart.dev (#…
5d1aa2c 
…4333)

Contributes to dart-lang/linter#4460 and dart-lang/site-www#4499
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Jun 28, 2023
@parlough
Update analysis, linter, and repo links in analysis options (#129686)
c65e908 
Contributes to dart-lang/linter#4460 and dart-lang/site-www#4499
@parlough parlough mentioned this issue Jul 1, 2023
Merged
auto-submit bot pushed a commit to flutter/flutter that referenced this issue Jul 1, 2023
@parlough
Update links to old linter site to dart.dev (#129866)
63a8298 
Removes the remaining links to the old linter site, to the guaranteed dart.dev/lints redirect.

Contributes to dart-lang/linter#4460 and dart-lang/site-www#4499
@parlough parlough mentioned this issue Jul 20, 2023
Merged
@parlough parlough mentioned this issue Jul 30, 2023
Merged
@pq
Copy link
Member Author

pq commented Aug 4, 2023

@parlough: are we basically done here? Anything else we need to be tracking?

@parlough
Copy link
Member

parlough commented Aug 4, 2023 •
edited
Loading

I think this issue can be closed :)

Edit: If there any internal links to the old site, might want to update those. I also have https://dart-review.googlesource.com/c/sdk/+/311880 open still.

@pq
Copy link
Member Author

pq commented Aug 4, 2023

Yay! Thanks for all of your help!

@pq pq closed this as completed Aug 4, 2023
@pq pq mentioned this issue Aug 4, 2023
Merged
copybara-service bot pushed a commit to dart-lang/sdk that referenced this issue Aug 4, 2023
@parlough
Update old linter site links to dart.dev
9974559 
Bug: dart-lang/linter#4460 and dart-lang/site-www#4499
Change-Id: Ieb90512aac4e476b922765c6ee191085a2ad2c9b
CoreLibraryReviewExempt: Only updates a link in documentation comments.
Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/311880
Commit-Queue: Phil Quitslund <[email protected]>
Reviewed-by: Brian Wilkerson <[email protected]>
Reviewed-by: Phil Quitslund <[email protected]>
@parlough parlough mentioned this issue Aug 11, 2023
Closed
rmacnak-google pushed a commit to rmacnak-google/site-www that referenced this issue Sep 5, 2023
@parlough @rmacnak-google
Implement individual linter rule pages (dart-lang#4999)
a448ff1 
This PR is meant to finalize work to make dart.dev a satisfactory
replacement for
[`dart-lang.github.io/linter/`](https://dart-lang.github.io/linter/)
while `dart-lang/linter` moves to the SDK and we work on consolidating
and improving documentation
(dart-lang#4498).

It does this by (staged links after colon (`:`)):

- Updating the information on dart.dev/lints for the latest state of the
linter:
[/lints](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/tools/linter-rules)
- Making dart.dev/lints an index page rather than including all
information:
[/lints](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/tools/linter-rules)
- Moving the long-form lint rule documentation to individual pages found
at `dart.dev/lints/<rule>`:
[/lints/avoid_dynamic_calls](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/lints/avoid_dynamic_calls)
- It does this by using a Jekyll page generator based on
`linter_rules.json`.
- Adding a textual reference pointing to the recently released all
linter rules page
(dart-lang@38973de)
found at:
[/lints/all](https://dart-dev--pr4999-feature-linter-indiv-zetj76b0.web.app/lints/all)
- Updating and links and references for these previous changes (mostly
Effective Dart).

Contributes to dart-lang/linter#4460,
dart-lang#4498,
dart-lang#4499

**Note:** This is an intermediate step and doesn't aim to improve the
formatting or style of the information on the index or individual pages.
That will be part of follow-up work as we work on improvements to the
diagnostic linter rule documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
P2 A bug or feature request we're likely to work on type-documentation A request to add or improve documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@pq @parlough