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.

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 - frontmatter #23272

Merged
merged 19 commits into from
Jun 13, 2022
Merged

docs - frontmatter #23272

merged 19 commits into from
Jun 13, 2022

Conversation

jeff-bruemmer
Copy link
Member

@jeff-bruemmer jeff-bruemmer commented Jun 9, 2022

Adds frontmatter with title key to doc pages.

Additionally, it updates src/metabase/cmd/endpoint-dox.clj script to generate frontmatter for API doc pages.

This is step one in improving our doc search results' title formatting, as well as other places where we use the de-slugged URL in place of an actual page title on our website.

@jeff-bruemmer jeff-bruemmer self-assigned this Jun 9, 2022
@codecov
Copy link

codecov bot commented Jun 9, 2022

Codecov Report

Merging #23272 (ae45f55) into master (91da786) will decrease coverage by 0.02%.
The diff coverage is 78.57%.

@@            Coverage Diff             @@
##           master   #23272      +/-   ##
==========================================
- Coverage   64.10%   64.08%   -0.03%     
==========================================
  Files        2582     2620      +38     
  Lines       82241    82427     +186     
  Branches    10162    10169       +7     
==========================================
+ Hits        52723    52822      +99     
- Misses      25344    25426      +82     
- Partials     4174     4179       +5     
Flag Coverage Δ
back-end 85.48% <78.57%> (+<0.01%) ⬆️
front-end 44.53% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/metabase/util.clj 90.27% <20.00%> (-0.74%) ⬇️
src/metabase/cmd/endpoint_dox.clj 60.40% <91.30%> (+6.67%) ⬆️
.../components/DrawerSection/DrawerSection.styled.jsx 0.00% <0.00%> (-60.00%) ⬇️
...etabase/components/DrawerSection/DrawerSection.jsx 0.00% <0.00%> (-46.67%) ⬇️
.../homepage/components/HomeGreeting/HomeGreeting.tsx 75.00% <0.00%> (-10.72%) ⬇️
.../ModerationReviewBanner/ModerationReviewBanner.jsx 87.50% <0.00%> (-7.24%) ⬇️
...uery_builder/components/QuestionActions.styled.tsx 50.00% <0.00%> (-7.15%) ⬇️
frontend/src/metabase/selectors/settings.js 58.82% <0.00%> (-5.89%) ⬇️
frontend/src/metabase/components/Timeline.jsx 77.77% <0.00%> (-3.48%) ⬇️
.../metabase/collections/components/BaseTableItem.jsx 53.57% <0.00%> (-2.43%) ⬇️
... and 117 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 91da786...ae45f55. Read the comment docs.

Copy link
Member

@camsaul camsaul left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jeff-bruemmer jeff-bruemmer merged commit b337f51 into master Jun 13, 2022
@jeff-bruemmer jeff-bruemmer deleted the docs-frontmatter branch June 13, 2022 18:54
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