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

docs: formatting updates to api reference #271

Closed
wants to merge 17 commits into from
Closed

docs: formatting updates to api reference #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e2f9eb1
first round of good changes
ericmariasis Feb 2, 2025
40d17cd
Made resource names bigger and a back to top button
ericmariasis Feb 2, 2025
797381f
added newlines
ericmariasis Feb 2, 2025
49e3b92
docs: removal of deprecated kubectl command in installation.md (#264)
ericmariasis Feb 1, 2025
b141b29
chore: fixes PR style check (#266)
mathetake Feb 1, 2025
50b7be5
ci: cleanup PR Style Check GHA (#268)
mathetake Feb 1, 2025
15f21b8
ci: relaxes PR title length check (#269)
mathetake Feb 1, 2025
0011851
docs: add note for Windows users in basic usage (#265)
ericmariasis Feb 1, 2025
6bc4a3e
chore: more clarify what to do on Style check failure (#272)
mathetake Feb 2, 2025
4669ddf
trivial update
ericmariasis Feb 2, 2025
329675c
changed font and committed files
ericmariasis Feb 2, 2025
883fb0b
changed font and committed files
ericmariasis Feb 2, 2025
3329db3
committed api md
ericmariasis Feb 2, 2025
c1f2c78
Merge branch 'main' into issue_241
ericmariasis Feb 2, 2025
38a1ba2
uncommitted api md
ericmariasis Feb 2, 2025
e43229a
Merge branch 'issue_241' of https://github.com/ericmariasis/ai-gatewa…
ericmariasis Feb 2, 2025
36b8081
trivial change to type.tpl
ericmariasis Feb 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions site/crd-ref-docs/config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,7 @@ render:
- name: ExtProc
package: github.com/envoyproxy/gateway/api/v1alpha1
link: https://gateway.envoyproxy.io/docs/api/extension_types/#extproc

navigation:
includeTOC: true
includeBackToTopLinks: true
9 changes: 6 additions & 3 deletions site/crd-ref-docs/templates/gv_details.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
{{- define "gvDetails" -}}
{{- $gv := . -}}

## {{ $gv.GroupVersionString }}
<a name="{{ lower (replace $gv.GroupVersionString " " "-" ) }}"></a>
# {{ $gv.GroupVersionString }}

{{ $gv.Doc }}

{{- if $gv.Kinds }}
### Resource Types
## Resource Types
{{- range $gv.SortedKinds }}
- {{ $gv.TypeForKind . | markdownRenderTypeLink }}
- {{ markdownRenderTypeLink ($gv.TypeForKind .) }}
{{- end }}
{{ end }}

{{ range $gv.SortedTypes }}
{{ template "type" . }}
{{ end }}

[Back to Packages](#api_references)

{{- end -}}
6 changes: 3 additions & 3 deletions site/crd-ref-docs/templates/gv_list.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{{- define "gvList" -}}
{{- $groupVersions := . -}}


---
id: api_references
title: API Reference
---

## Packages
<a id="api_references"></a>
# Packages
{{- range $groupVersions }}
- {{ markdownRenderGVLink . }}
- [{{ .GroupVersionString }}](#{{ lower (replace .GroupVersionString " " "-" ) }})
{{- end }}

{{ range $groupVersions }}
Expand Down
2 changes: 1 addition & 1 deletion site/crd-ref-docs/templates/type.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{{- $type := . -}}
{{- if markdownShouldRenderType $type -}}

#### {{ $type.Name }}
### {{ $type.Name }}

{{ if $type.IsAlias }}_Underlying type:_ _{{ markdownRenderTypeLink $type.UnderlyingType }}_{{ end }}

Expand Down
Loading