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

Rename docsPage => autodocs #20364

Merged
merged 4 commits into from
Dec 22, 2022
Merged

Rename docsPage => autodocs #20364

merged 4 commits into from
Dec 22, 2022

Conversation

tmeasday
Copy link
Member

@tmeasday tmeasday commented Dec 21, 2022

Issue: N/A

Telescoping on #20363

What I did

Changed:
- docsPage: true => autodocs: 'tag'
- docsPage: 'automatic' => autodocs: true.

I didn't really properly look at the docs yet, I think a second pass over the docs alongside doc blocks changes makes sense. (cc @jonniebigodes though).

How to test

Hopefully unit tests should catch this.

And change semantics: `docsPage:true` = `autodocs: 'tag'` and `docsPage: 'automatic'` = `autodocs: true`.
@tmeasday tmeasday added maintenance User-facing maintenance tasks addon: docs labels Dec 21, 2022
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@tmeasday, thanks for taking care of this. Looks good to me! I'll take a pass at the rest of the docs (i.e., doc blocks) and adjust accordingly.

Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

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

LGTM!

MIGRATION.md Outdated Show resolved Hide resolved
Co-authored-by: Michael Shilman <shilman@users.noreply.github.com>
Base automatically changed from tom/sb-973-rename-docsenabled-to-docsdisable to next December 22, 2022 05:45
@tmeasday tmeasday merged commit 932ffc8 into next Dec 22, 2022
@tmeasday tmeasday deleted the rename-docspage-autodocs branch December 22, 2022 05:45
@yannbf
Copy link
Member

yannbf commented Dec 22, 2022

@tmeasday can you change the automigration so it migrates docsPage automatic to autodocs too? Users will get confused, and they probably need to update their stories too?

@tmeasday
Copy link
Member Author

Sure: #20379

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants