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.

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

[docs] [revamp] - Beefing up Vale #23754

Merged
merged 11 commits into from
Aug 20, 2024
Merged

[docs] [revamp] - Beefing up Vale #23754

merged 11 commits into from
Aug 20, 2024

Conversation

erinkcochran87
Copy link
Contributor

Summary & Motivation

This PR beefs up our Vale implementation with some custom rules and vocabularies. The README for this will be updated in a subsequent PR.

How I Tested These Changes

eyes, local

Copy link

netlify bot commented Aug 20, 2024

Deploy Preview for dagsterapidocs ready!

Name Link
🔨 Latest commit dd59da1
🔍 Latest deploy log https://app.netlify.com/sites/dagsterapidocs/deploys/66c4c01e6735960008f0b0b0
😎 Deploy Preview https://deploy-preview-23754--dagsterapidocs.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 configuration.

@graphite-app graphite-app bot added the area: docs Related to documentation in general label Aug 20, 2024
@erinkcochran87 erinkcochran87 merged commit 75b334e into docs/revamp Aug 20, 2024
6 of 7 checks passed
@erinkcochran87 erinkcochran87 deleted the erin/beefy-vale branch August 20, 2024 16:17
Copy link

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-nrw479zfp-elementl.vercel.app
https://erin-beefy-vale.dagster.dagster-docs.io

Direct link to changed pages:
docs/docs-beta/docs/concepts/schedules

@PedramNavid
Copy link
Contributor

I ran these new styles against the existing docs-beta content. Generally looks fine, however when adding new linting rules, generally we want to make sure we don't introduce errors that weren't there before.

Here's my thoughts:

  • Readability is a hard metric to measure for people. E.g. Intro is at 15, what does it mean for it to be 8? I would suggest we keep readability as part of the human review process and not an automated metric
  • Removing API from an accept.txt causes a heading like # Using API connections to fail. Same for ETL and SDA
  • A lot of the Gerund errors are from the seeded sections you had added. We should either remove this rule, or fix them all as part of this PR.

@erinkcochran87
Copy link
Contributor Author

erinkcochran87 commented Aug 20, 2024

Readability is a hard metric to measure for people. E.g. Intro is at 15, what does it mean for it to be 8? I would suggest we keep readability as part of the human review process and not an automated metric

@PedramNavid Thanks for catching this - I was tinkering around and forgot to remove it.

Removing API from an accept.txt causes a heading like # Using API connections to fail. Same for ETL and SDA

I'll look into this. For SDA, are you talking about Software-defined Assets? If so, we shouldn't be using this acronym as we deprecated the term.

A lot of the Gerund errors are from the seeded sections you had added. We should either remove this rule, or fix them all as part of this PR.

Agreed! I didn't know about the translation issue (the reason behind this rule), so I'll fix the headings.

Copy link
Contributor

We don't translate our docs so we can also remove the rule if needed.

If we deprecated SDAs lets add a replacement rule

erinkcochran87 added a commit that referenced this pull request Aug 20, 2024
## Summary & Motivation

This PR addresses comments in #23754 

## How I Tested These Changes
PedramNavid pushed a commit that referenced this pull request Aug 20, 2024
## Summary & Motivation

This PR beefs up our Vale implementation with some custom rules and
vocabularies. The README for this will be updated in a subsequent PR.

## How I Tested These Changes

eyes, local
PedramNavid pushed a commit that referenced this pull request Aug 20, 2024
## Summary & Motivation

This PR addresses comments in #23754 

## How I Tested These Changes
PedramNavid pushed a commit that referenced this pull request Aug 21, 2024
## Summary & Motivation

This PR beefs up our Vale implementation with some custom rules and
vocabularies. The README for this will be updated in a subsequent PR.

## How I Tested These Changes

eyes, local
PedramNavid pushed a commit that referenced this pull request Aug 21, 2024
## Summary & Motivation

This PR addresses comments in #23754 

## How I Tested These Changes
PedramNavid added a commit that referenced this pull request Aug 21, 2024
## Summary & Motivation

Brings in #23754 and #23758 into the master branch for docs-beta
styling.

## How I Tested These Changes

---------

Co-authored-by: Erin Cochran <[email protected]>
PedramNavid added a commit that referenced this pull request Aug 21, 2024
Brings in #23754 and #23758 into the master branch for docs-beta
styling.

---------

Co-authored-by: Erin Cochran <[email protected]>
sryza pushed a commit that referenced this pull request Aug 24, 2024
## Summary & Motivation

Brings in #23754 and #23758 into the master branch for docs-beta
styling.

## How I Tested These Changes

---------

Co-authored-by: Erin Cochran <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Related to documentation in general
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants