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: Standardize providers.yaml display names #3478

Merged
merged 2 commits into from
Feb 7, 2025

Conversation

bastienbeurier
Copy link
Member

@bastienbeurier bastienbeurier commented Feb 7, 2025

Guidelines I used:

  • Only specify auth type when there are multiple auth types for a given API
  • Capitalize auth type
  • Uppercase for acronyms

Copy link

linear bot commented Feb 7, 2025

@bastienbeurier bastienbeurier requested a review from a team February 7, 2025 10:50
@bastienbeurier
Copy link
Member Author

@nalanj just checking that this will sync automatically with Webflow when merged.

Copy link
Collaborator

@bodinsamuel bodinsamuel left a comment

Choose a reason for hiding this comment

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

Could be added to scripts/validation/providers/validate.ts so it's enforced

@bastienbeurier
Copy link
Member Author

Could be added to scripts/validation/providers/validate.ts so it's enforced

Agreed, though some edge cases might be challenging to systematize.

@nalanj
Copy link
Contributor

nalanj commented Feb 7, 2025

@bastienbeurier it will indeed sync after merge

@nalanj
Copy link
Contributor

nalanj commented Feb 7, 2025

Worth noting - I've bumped into a few cases where the document title doesn't match the provider name. When I created all the new ones I tried to set them correctly, but it's another kind of grunt work thing that probably should be knocked out.

@bastienbeurier bastienbeurier force-pushed the bastien/nan-2661/standardize-api-names branch from 3d2988a to 9f19f72 Compare February 7, 2025 13:50
@bastienbeurier bastienbeurier enabled auto-merge (squash) February 7, 2025 13:52
@bastienbeurier bastienbeurier merged commit 53da590 into master Feb 7, 2025
17 checks passed
@bastienbeurier bastienbeurier deleted the bastien/nan-2661/standardize-api-names branch February 7, 2025 13:56
@bastienbeurier
Copy link
Member Author

Worth noting - I've bumped into a few cases where the document title doesn't match the provider name. When I created all the new ones I tried to set them correctly, but it's another kind of grunt work thing that probably should be knocked out.

@nalanj the API docs page title is not synced with the providers.yaml display name?

@nalanj
Copy link
Contributor

nalanj commented Feb 7, 2025

@bastienbeurier it is not

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants