This repository was archived by the owner on Jan 8, 2025. It is now read-only.
Closed
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Contributor
Author
|
Converting to draft until I fix the |
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
5d80130 to
2c533d3
Compare
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
2c533d3 to
249e366
Compare
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
249e366 to
2fadfac
Compare
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jun 30, 2023
Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327.
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
2fadfac to
c9a02ed
Compare
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 5, 2023
Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327.
github-merge-queue Bot
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jul 5, 2023
* Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 7, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
c9a02ed to
e818699
Compare
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 10, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
The `forScopes` field of a navigation entry in `docs/config.json` determines which scope switcher buttons appear on a docs page. If a scoped component supports a scope that does not appear in the switcher, the user can only adjust the visibility of the component using the `scope` query string. Further, if a `Tabs` component includes some scopes but not all of the ones listed in a page's `forScopes`, it's likely that the page's `forScopes` setting is misconfigured. This change adds a linter that checks whether: - A page's scoped components include any scopes that are _not_ listed in `forScopes`. - `Tabs` components that include at least one scope in the `forScopes` configuration _also_ include the remaining scopes. The linter only performs this check for `Tabs` components since it's the only component that we expect to always include all scopes within a set. This change will make it easier to incorporate Teleport Team instructions into the docs, since we can configure the linter to check for the `team` scope in scoped `Tabs` components and ensure that the `forScopes` setting is configured correctly.
ptgott
force-pushed
the
paul.gottschling/2023-06-scope-linter
branch
from
e818699 to
12c5a84
Compare
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 10, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
ravicious
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jul 11, 2023
* Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 13, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
ptgott
added a commit
to gravitational/teleport
that referenced
this pull request
Jul 13, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
github-merge-queue Bot
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jul 13, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
github-merge-queue Bot
pushed a commit
to gravitational/teleport
that referenced
this pull request
Jul 14, 2023
Backports #28443 * Edit forScopes configurations and edit guides Closes #26500 This change requires merging gravitational/docs#326 to add a Team scope to the docs. This updates pages within the docs so that: - Each page's `forScopes` configuration is accurate, especially with regard to support for Teleport Team. - All scoped components match the `forScopes` configuration for each page. For this, I used the linter introduced by gravitational/docs#327. * Respond to alexfornuto feedback
Contributor
Author
|
Note: we should wait until v14 is out before we merge this. Doing so will simplify the process of getting this linter to pass, since v11 of the docs don't support Teleport Team. |
Contributor
Author
|
Closing because we are removing the scoped visibility functionality from the docs (#383). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
forScopesfield of a navigation entry indocs/config.jsondetermines which scope switcher buttons appear on a docs page. If a scoped component supports a scope that does not appear in the switcher, the user can only adjust the visibility of the component using thescopequery string.Further, if a
Tabscomponent includes some scopes but not all of the ones listed in a page'sforScopes, it's likely that the page'sforScopessetting is misconfigured.This change adds a linter that checks whether:
forScopes.Tabscomponents that include at least one scope in theforScopesconfiguration also include the remaining scopes. The linter only performs this check forTabscomponents since it's the only component that we expect to always include all scopes within a set.This change will make it easier to incorporate Teleport Team instructions into the docs, since we can configure the linter to check for the
teamscope in scopedTabscomponents and ensure that theforScopessetting is configured correctly.