Skip to content

Commit 8f9ee2c

Browse files
authored
docs: update implements page (#3996)
* fix: implements page show wrong result if there's more than one mode/version/project * remove print * add core result * update * semver compare * update * remove prefix * display on 1.3.0
1 parent ab6b5a2 commit 8f9ee2c

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,10 +166,13 @@ release-staging: image.multiarch.setup
166166

167167
# Docs
168168

169+
DOCS_BUILD_CONTAINER_NAME ?= gateway-api-mkdocs
170+
169171
.PHONY: build-docs
170172
build-docs:
171173
docker build --pull -t gaie/mkdocs hack/mkdocs/image
172-
docker run --rm -v ${PWD}:/docs gaie/mkdocs build
174+
docker rm -f $(DOCS_BUILD_CONTAINER_NAME) || true
175+
docker run --name $(DOCS_BUILD_CONTAINER_NAME) --rm -v ${PWD}:/docs gaie/mkdocs build
173176

174177
.PHONY: build-docs-netlify
175178
build-docs-netlify:

hack/mkdocs-generate-conformance.py

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import glob
2323
import os
2424
import re
25+
import semver
2526

2627
log = logging.getLogger(f'mkdocs.plugins.{__name__}')
2728

@@ -149,7 +150,7 @@ def generate_conformance_tables(reports, currVersion, mkdocsConfig):
149150

150151
return new_file
151152

152-
def generate_profiles_report(reports, route,version):
153+
def generate_profiles_report(reports, route, version):
153154

154155
http_reports = reports.loc[reports["name"] == route]
155156
http_reports.set_index('organization')
@@ -159,21 +160,32 @@ def generate_profiles_report(reports, route,version):
159160
columns=http_reports['organization'])
160161

161162
http_table = http_reports[['organization', 'project',
162-
'version','mode', 'extended.supportedFeatures']].T
163+
'version', 'mode', 'core.result', 'extended.supportedFeatures']].T
163164
http_table.columns = http_table.iloc[0]
164165
http_table = http_table[1:].T
166+
# change core.result value
165167

166168
for row in http_table.itertuples():
167-
if type(row._4) is list:
168-
for feat in row._4:
169+
if row._4 == "success":
170+
http_table.loc[(row.Index, 'core.result')] = ':white_check_mark:'
171+
else:
172+
http_table.loc[(row.Index, 'core.result')] = ':x:'
173+
174+
if type(row._5) is list:
175+
for feat in row._5:
169176
# Process feature name before using it as a column
170177
processed_feat = process_feature_name(feat)
171-
http_table.loc[row.Index, processed_feat] = ':white_check_mark:'
178+
http_table.loc[(http_table.index == row.Index) & \
179+
(http_table['project'] == row.project) & \
180+
(http_table['version'] == row.version) & \
181+
(http_table['mode'] == row.mode), processed_feat] = ':white_check_mark:'
172182
http_table = http_table.fillna(':x:')
173183
http_table = http_table.drop(['extended.supportedFeatures'], axis=1)
174184

175185
http_table = http_table.rename(
176-
columns={"project": "Project", "version": "Version", "mode":"Mode"})
186+
columns={"project": "Project", "version": "Version", "mode": "Mode", "core.result": "Core"})
187+
if semver.compare(version.removeprefix('v'), '1.3.0') < 0:
188+
http_table = http_table.drop(columns=["Core"])
177189
if version == 'v1.0.0':
178190
http_table = http_table.drop(columns=["Mode"])
179191
return http_table

hack/mkdocs/image/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,5 @@ pymdown-extensions==10.16.1
2020
PyYAML==6.0.2
2121
six==1.17.0
2222
tabulate==0.9.0
23-
tornado==6.5.2
23+
tornado==6.5.2
24+
semver==3.0.4

0 commit comments

Comments
 (0)