Skip to content

Fix redocly plugins #7149

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

Closed
wants to merge 1 commit into from
Closed

Conversation

osfameron
Copy link
Contributor

These crashed when description was missing, so add defaulting/logic to fix.
Enable the excise-rbac for the other APIs for the *-capella targets.

Ping @torcolvin to review - I don't think this checklist applies to this PR?
I can create a CBG if required.

CBG-0000

Describe your PR here...

  • Use bullet points if there's more than one thing changed

Pre-review checklist

  • Removed debug logging (fmt.Print, log.Print, ...)
  • Logging sensitive data? Make sure it's tagged (e.g. base.UD(docID), base.MD(dbName))
  • Updated relevant information in the API specifications (such as endpoint descriptions, schemas, ...) in docs/api

Dependencies (if applicable)

  • Link upstream PRs
  • Update Go module dependencies when merged

Integration Tests

These crashed when description was missing, so add defaulting/logic to fix.
Enable the excise-rbac for the other APIs for the *-capella targets.
@torcolvin torcolvin self-assigned this Oct 9, 2024
@torcolvin
Copy link
Collaborator

I think I know why the redocly_preview_links doesn't work but this only publishes not generated previews back to the PR. This is because this is a PR from a fork, and we always do PRs from branches like CBG-xxx. I granted the docs team access to be able to push branches like this. You can't merge without a PR.

We like all commits to have a jira ticket for tracking but it can be a DOC ticket, since you are doing the work, or a CBG ticket. No preference. Since this is a commit against main which is tracking 3.3, after this is merged, we typically create a backport ticket by cloning the existing ticket and marking as [3.2.1 backport]. Then once that is merged, I move the tag for docs. This process should probably be described in our meta doc docs.

Finally, this looks good except that I think info.title should be modified for public-capella since it says Sync Gateway instead of App Services. I verified with npx @redocly/cli@latest preview-docs public-capella.

@torcolvin torcolvin assigned osfameron and unassigned torcolvin Oct 10, 2024
@osfameron
Copy link
Contributor Author

Closing in favour of #7153

@osfameron osfameron closed this Oct 11, 2024
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.

2 participants