lsst-sqre / documenteer

Sphinx extensions, configurations, and tooling for Rubin Observatory documentation projects
https://documenteer.lsst.io
MIT License
5 stars 3 forks source link

Update migrate.rst #208

Closed frossie closed 6 months ago

frossie commented 6 months ago

Updates for a more guided linear flow

frossie commented 6 months ago

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 commented 6 months ago

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

jonathansick commented 6 months ago

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

frossie commented 6 months ago

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

jonathansick commented 6 months ago

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.