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

Update migrate.rst #208

Merged
merged 1 commit into from
Jan 2, 2024
Merged

Update migrate.rst #208

merged 1 commit into from
Jan 2, 2024

Conversation

frossie
Copy link
Member

@frossie frossie commented Dec 29, 2023

Updates for a more guided linear flow

@frossie frossie marked this pull request as ready for review December 29, 2023 21:11
@frossie
Copy link
Member Author

frossie commented Dec 29, 2023

PS> I have not been able to preview this because https://documenteer.lsst.io/v/index.html is not showing my branch so sorry for any layout issues

@jonathansick
Copy link
Member

Thanks. I'll fix up this PR next week.

@jonathansick
Copy link
Member

(The GitHub Actions workflow is set up to only publish preview for ticket branches)

@frossie
Copy link
Member Author

frossie commented Dec 29, 2023

You're meant to be on vacation, go away. I fixed the formatting issues by RTFMing and tox -e docs.

The migration docs were originally written around manual migration, and
then the documenteer tool was added later in the process. This update
now orients the steps in the migration to feature the automated
migration. Re-orient the previous manual migration as a file-by-file
reference of changes made.
@jonathansick
Copy link
Member

Ah, I understand the intent of the changes. The doc was originally written for a manual migration, and then the automated tool was shoehorned in when it became available. The flow of the migration here was better, but I went further and oriented the steps around setting up and running the manual migration, and then I turned the original manual migration section into a reference. It should read a lot more simply now. Thanks.

@jonathansick jonathansick merged commit df87f70 into main Jan 2, 2024
5 checks passed
@jonathansick jonathansick deleted the u/fe/1 branch January 2, 2024 20:55
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