Skip to content

Commit

Permalink
Chanch file structure per feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
xtineskim committed Jun 19, 2024
1 parent ffc335c commit 171606a
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 31 deletions.
22 changes: 4 additions & 18 deletions hack/mkdocs-generate-conformance.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ def on_pre_build(config, **kwargs):
log.info("generating conformance")

vers = getConformancePaths()
for v in vers[3:]:

for v in vers[4:]:
confYamls = getYaml(v)
releaseVersion = v.split(os.sep)[-2]
generate_conformance_tables(confYamls, releaseVersion)
Expand All @@ -54,17 +54,6 @@ def on_pre_build(config, **kwargs):
'HTTPRoutePathRedirect', 'HTTPRouteHostRewrite', 'HTTPRoutePathRewrite', 'HTTPRouteRequestMirror', 'HTTPRouteRequestMultipleMirrors', 'HTTPRouteRequestTimeout', 'HTTPRouteBackendTimeout', 'HTTPRouteParentRefPort']


# NOTE add past versions of implementations to here when new release is cut
past_versions = """
??? "Previous Gateway API Versions"
The latest release of Gateway API is shown here. Past Gateway API implementations and feature support can be found here:
- [v1.0.0](./implementation-table-v1.0.0.md)
"""


def generate_conformance_tables(reports, currVersion):

gateway_tls_table = pandas.DataFrame()
Expand All @@ -87,17 +76,16 @@ def generate_conformance_tables(reports, currVersion):
gateway_http_table = gateway_http_table.rename_axis('Organization')
mesh_http_table = mesh_http_table.rename_axis('Organization')

with open('site-src/implementation-table-'+currVersion+'.md', 'w') as f:
versionFile = ".".join(currVersion.split(".")[:2])

with open('site-src/implementations/'+versionFile+'.md', 'w') as f:

f.write(desc)
f.write("\n\n")

f.write(warning_text)
f.write("\n\n")

f.write(past_versions)
f.write("\n\n")

f.write("## Gateway Profile\n\n")
f.write("### HTTPRoute\n\n")
f.write(gateway_http_table.to_markdown()+'\n\n')
Expand Down Expand Up @@ -151,12 +139,10 @@ def getConformancePaths():
vers = v.split(os.sep)[-2]
allVersions.append(vers)
reportedImplementationsPath.append(v+"**")
log.info(report_path)
return reportedImplementationsPath


def getYaml(conf_path):
log.info("parsing conformance reports ============================")
yamls = []

for p in glob.glob(conf_path, recursive=True):
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,9 @@ nav:
Service Facets: mesh/service-facets.md
- Implementations:
- List: implementations.md
- Comparison: implementation-table-v1.1.0.md
- Past Version Comparisons:
- v1.0.0: implementation-table-v1.0.0.md
- Comparisons:
- v1.1: implementations/v1.1.md
- v1.0: implementations/v1.0.md
- FAQ: faq.md
- Glossary: concepts/glossary.md
- Guides:
Expand Down
2 changes: 1 addition & 1 deletion site-src/implementations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ cover, and documentation to help users get started.

!!! info "Compare extended supported features across implementations"

[View a table to quickly compare supported features of projects](/implementation-table). These outline Gateway controller implementations that have passed core conformance tests, and focus on extended conformance features that they have implemented.
[View a table to quickly compare supported features of projects](/implementations/v1.1). These outline Gateway controller implementations that have passed core conformance tests, and focus on extended conformance features that they have implemented.

## Gateway Controller Implementation Status <a name="gateways"></a>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,6 @@ Implementations only appear in this page if they pass Core conformance for the r
However, as it is based on submitted conformance reports, the information is correct.



??? "Previous Gateway API Versions"


The latest release of Gateway API is shown here. Past Gateway API implementations and feature support can be found here:

- [v1.0.0](./implementation-table-v1.0.0.md)


## Gateway Profile

### HTTPRoute
Expand Down

0 comments on commit 171606a

Please sign in to comment.