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-infra] Add configurable jsdoc host variable #42472

Merged
merged 7 commits into from
Jun 7, 2024
Merged

[docs-infra] Add configurable jsdoc host variable #42472

merged 7 commits into from
Jun 7, 2024

Conversation

tonygravell
Copy link
Contributor

@tonygravell tonygravell commented Jun 1, 2024 •
edited
Loading

In this PR:

  • Added optional setting to ProjectSettings.ts to allow configurable host baseApiUrl
  • Updated files which require a dynamic host variable when creating JSDocs

Addresses issue:
#42361

@mui-bot
Copy link

mui-bot commented Jun 1, 2024 •
edited
Loading

Netlify deploy preview

https://deploy-preview-42472--material-ui.netlify.app/

Bundle size report

No bundle size changes (Toolpad)
No bundle size changes

Generated by 🚫 dangerJS against f619823

alexfauquette
alexfauquette reviewed Jun 3, 2024
View reviewed changes
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Looks solid 🚀

tonygravell and others added 3 commits June 3, 2024 16:51
@tonygravell @alexfauquette
Update packages/api-docs-builder-core/baseUi/projectSettings.ts
166b78a 
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Signed-off-by: Anthony Gravell <73857273+tonygravell@users.noreply.github.com>
@tonygravell @alexfauquette
Update packages/api-docs-builder-core/materialUi/projectSettings.ts
cc5c8c0 
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Signed-off-by: Anthony Gravell <73857273+tonygravell@users.noreply.github.com>
@alexfauquette
run script
d093cf1
@alexfauquette alexfauquette mentioned this pull request Jun 4, 2024
Closed
@tonygravell tonygravell marked this pull request as ready for review June 5, 2024 19:55
@tonygravell tonygravell requested a review from alexfauquette June 5, 2024 19:55
@alexfauquette alexfauquette requested a review from a team June 5, 2024 20:03
DiegoAndai
DiegoAndai reviewed Jun 5, 2024
View reviewed changes
packages/api-docs-builder-core/baseUi/projectSettings.ts Outdated
@@ -43,4 +43,6 @@ export const projectSettings: ProjectSettings = {
translationPagesDirectory: 'docs/translations/api-docs-base',
generateClassName: generateUtilityClass,
isGlobalClassName: isGlobalState,
// #major-version-switch
Copy link
Member

Choose a reason for hiding this comment

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

@mnajdova is #major-version-switch the correct flag? I don't know if we have another flag for it.

Copy link
Member

Choose a reason for hiding this comment

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

#default-branch-switch is much more used, honestly first time I see the #major-version-switch :)

Copy link
Member

@alexfauquette alexfauquette Jun 6, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Come from here. I will harmonize it 👍

@oliviertassinari oliviertassinari added bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: material-ui Specific to @mui/material scope: docs-infra Specific to the docs-infra product labels Jun 5, 2024
@oliviertassinari oliviertassinari changed the title [material-ui] Added configurable jsdoc host variable [docs-indra] Add configurable jsdoc host variable Jun 5, 2024
@mnajdova mnajdova changed the title [docs-indra] Add configurable jsdoc host variable [docs-infra] Add configurable jsdoc host variable Jun 6, 2024
mnajdova
mnajdova approved these changes Jun 7, 2024
View reviewed changes
Copy link
Member

@mnajdova mnajdova left a comment

Choose a reason for hiding this comment

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

LGTM 👌, thanks for the contribution! I will let @alexfauquette do the last review.

alexfauquette
alexfauquette approved these changes Jun 7, 2024
View reviewed changes
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Good for me, I just wanted the confirmation from core team, we are not bothering them with those diff ;)

@alexfauquette alexfauquette merged commit 8a741e4 into mui:next Jun 7, 2024
22 checks passed
joserodolfofreitas pushed a commit to joserodolfofreitas/material-ui that referenced this pull request Jul 29, 2024
@tonygravell @alexfauquette @joserodolfofreitas
[docs-infra] Add configurable jsdoc host variable (mui#42472)
c1ebce4 
Signed-off-by: Anthony Gravell <73857273+tonygravell@users.noreply.github.com>
Co-authored-by: Tony Gravell <tonygravell@Tonys-Mac-mini.local>
Co-authored-by: Alexandre Fauquette <45398769+alexfauquette@users.noreply.github.com>
Co-authored-by: alexandre <alex.fauquette@gmail.com>
@alexfauquette alexfauquette mentioned this pull request Aug 27, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexfauquette alexfauquette alexfauquette approved these changes

@mnajdova mnajdova mnajdova approved these changes

@DiegoAndai DiegoAndai Awaiting requested review from DiegoAndai

Assignees
No one assigned
Labels
bug 🐛 Something doesn't work docs Improvements or additions to the documentation package: material-ui Specific to @mui/material scope: docs-infra Specific to the docs-infra product
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@tonygravell @mui-bot @mnajdova @DiegoAndai @alexfauquette @oliviertassinari