Skip to content

docs(repo): linting with ssgs#2450

Merged
P0lip merged 1 commit into
developfrom
docs/pam-linting-with-ssgs
Apr 6, 2023
Merged

docs(repo): linting with ssgs#2450
P0lip merged 1 commit into
developfrom
docs/pam-linting-with-ssgs

Conversation

@pamgoodrich

@pamgoodrich pamgoodrich commented Apr 6, 2023 •
edited
Loading

Copy link
Copy Markdown
Contributor

Fixes https://github.com/stoplightio/platform-docs/pull/752.

Added note about hosted style guide updates and Spectral CLI.

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

@pamgoodrich pamgoodrich requested a review from a team as a code owner April 6, 2023 16:15
@pamgoodrich pamgoodrich requested review from billiegoose and removed request for billiegoose April 6, 2023 16:15
@pamgoodrich pamgoodrich requested a review from a team as a code owner April 6, 2023 17:07
dotslashderek
dotslashderek previously approved these changes Apr 6, 2023
View reviewed changes
Comment thread docs/guides/2-cli.md Outdated
- [OpenAPI ruleset](../reference/openapi-rules.md)
- [AsyncAPI ruleset](../reference/asyncapi-rules.md)

> If you use rules created or updated in a hosted [Stoplight API project](https://docs.stoplight.io/docs/platform/branches/pam-716-updated-landing-page/c433d678d027a-create-rules) with the Spectral CLI, you must publish the project from Stoplight before the updates are using for linting.

@dotslashderek dotslashderek Apr 6, 2023

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

"are using for linting" -> " are used for linting" :)

@pamgoodrich pamgoodrich changed the title Docs/pam linting with ssgs docs/pam linting with ssgs Apr 6, 2023
@pamgoodrich pamgoodrich changed the title docs/pam linting with ssgs linting with ssgs Apr 6, 2023
@pamgoodrich pamgoodrich changed the title linting with ssgs docs: linting with ssgs Apr 6, 2023
@pamgoodrich pamgoodrich changed the title docs: linting with ssgs chore(docs): linting with ssgs Apr 6, 2023
P0lip
P0lip suggested changes Apr 6, 2023
View reviewed changes

@P0lip P0lip left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I don't think we should be including a style guide in Spectral project itself.
This is likely to cause confusion for people.
Thoughts @mnaumanali94?

The docs change is OK though.

@P0lip P0lip force-pushed the docs/pam-linting-with-ssgs branch from b5d3f8c to 8f2994f Compare April 6, 2023 18:42
@P0lip P0lip changed the title chore(docs): linting with ssgs docs(docs): linting with ssgs Apr 6, 2023
@P0lip P0lip force-pushed the docs/pam-linting-with-ssgs branch from 8f2994f to 586e2b7 Compare April 6, 2023 18:42
P0lip
P0lip previously approved these changes Apr 6, 2023
View reviewed changes
@P0lip P0lip changed the title docs(docs): linting with ssgs docs(repo): linting with ssgs Apr 6, 2023
@P0lip P0lip force-pushed the docs/pam-linting-with-ssgs branch from 586e2b7 to 70813ad Compare April 6, 2023 18:43
@pamgoodrich

pamgoodrich commented Apr 6, 2023

Copy link
Copy Markdown
Contributor Author

I don't think we should be including a style guide in Spectral project itself. This is likely to cause confusion for people. Thoughts @mnaumanali94?

The docs change is OK though.

I don't think we should be including a style guide in Spectral project itself. This is likely to cause confusion for people. Thoughts @mnaumanali94?

The docs change is OK though.

Good point, Jakub. Should I remove both the styleguide.json and .spectral.mjs files?

@P0lip

P0lip commented Apr 6, 2023

Copy link
Copy Markdown
Contributor

Good point, Jakub. Should I remove both the styleguide.json and .spectral.mjs files?

I took care of that already :)

@P0lip P0lip merged commit d3bebe4 into develop Apr 6, 2023
@P0lip P0lip deleted the docs/pam-linting-with-ssgs branch April 6, 2023 18:45
@stoplight-bot

stoplight-bot commented May 23, 2023

Copy link
Copy Markdown
Collaborator

🎉 This PR is included in version 6.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@dotslashderek dotslashderek dotslashderek left review comments

@P0lip P0lip P0lip left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@pamgoodrich @P0lip @stoplight-bot @dotslashderek