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.

Sign up for GitHub

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

Jump to bottom

docs: update markdown format #10362

Merged
merged 28 commits into from
Nov 22, 2024
Merged

docs: update markdown format #10362

merged 28 commits into from
Nov 22, 2024

Conversation

sam-heilbron
Copy link

@sam-heilbron sam-heilbron commented Nov 16, 2024 •
edited
Loading

Description

update some formatting in our user-facing documentation

Context

Relies on changes introduced in solo-io/solo-kit#571

  • Format of generated docs is updated
  • .proto.sk.md files have updated tiltles, so custom_resource.proto.sk.md has a title of CustomResource

Interesting decisions

Testing steps

  • no user-facing changes, so rely on CI passing

Notes for reviewers

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works

@sam-heilbron sam-heilbron mentioned this pull request Nov 16, 2024
Merged
@solo-changelog-bot
Copy link

Issues linked to changelog:
https://github.com/solo-io/solo-projects/issues/6612

@sam-heilbron sam-heilbron marked this pull request as ready for review November 20, 2024 16:00
@sam-heilbron sam-heilbron requested a review from a team as a code owner November 20, 2024 16:00
arianaw66
arianaw66 reviewed Nov 20, 2024
View reviewed changes
...t/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/gateway_parameters.md Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
docs/content/crds/generate.go Show resolved Hide resolved
docs/content/crds/README.md Outdated Show resolved Hide resolved
docs/content/crds/generate.go Outdated Show resolved Hide resolved
docs/content/crds/generate.go Outdated Show resolved Hide resolved
...ent/reference/api/github.com/solo-io/gloo/projects/gateway2/api/v1alpha1/direct_responses.md Outdated Show resolved Hide resolved
docs/content/crds/templates/markdown.tmpl Show resolved Hide resolved
...solo-io/gloo/projects/gloo/api/v1/enterprise/options/extauth/v1/extauth-internal.proto.sk.md Show resolved Hide resolved
docs/content/reference/api/github.com/solo-io/solo-kit/api/v1/solo-kit.proto.sk.md Show resolved Hide resolved
@soloio-bulldozer soloio-bulldozer bot merged commit e2ca028 into main Nov 22, 2024
17 of 18 checks passed
@soloio-bulldozer soloio-bulldozer bot deleted the sh/update-gloo-docs-format branch November 22, 2024 01:23
yuval-k pushed a commit that referenced this pull request Nov 22, 2024
@sam-heilbron @yuval-k
docs: update markdown format (#10362)
99f7178
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Nadine2016 Nadine2016 Nadine2016 approved these changes

@arianaw66 arianaw66 arianaw66 approved these changes

Assignees
No one assigned
Labels
keep pr updated
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sam-heilbron @arianaw66 @Nadine2016