Skip to content

Conversation

@joasode
Copy link
Contributor

@joasode joasode commented Mar 21, 2025

@joasode joasode requested a review from Chroxvi March 21, 2025 11:06
Copy link
Contributor

@Chroxvi Chroxvi left a comment

Choose a reason for hiding this comment

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

Here are some suggestions for taking a slightly different approach to this docs update, by:

  • Syncing the docs to the state of the main branch following the merge of #117, #118, #120, #126.
  • Describing dependency installation a little more generic, only recommending the use of uv.
  • Restructuring things to be more in line with the rest of the documentation - though this may need an even larger overhaul soon.

Furthermore, I think these other parts of the docs need an update as part of this PR:

  • The Schedules tests section needs a minor update to reflect our new uv based setup.
  • The Docs dependencies section needs an update about installing the "docs" dependency group from the pyproject.toml file - similar to how the "test" dependency installation is described in this PR.
  • The pre-commit section needs an update about installing the "lint" dependency group from the pyproject.toml file - similar to how the "test" dependency installation is described in this PR.
  • I think the CLI internals section should just assume you have installed cotainr via pip and, thus, only mention running cotainr build ... etc. Maybe it should still mention the bin/cotainr script as an alternative to the pip installed entrypoint.

Chroxvi
Chroxvi previously approved these changes Mar 27, 2025
Copy link
Contributor

@Chroxvi Chroxvi left a comment

Choose a reason for hiding this comment

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

Look good to me. I noted two typos, you might want to correct.

Co-authored-by: Christian Schou Oxvig <[email protected]>
Copy link
Contributor

@Chroxvi Chroxvi left a comment

Choose a reason for hiding this comment

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

I think this is ready for merge.

@joasode joasode merged commit c0c83ac into main Mar 27, 2025
31 checks passed
@joasode joasode deleted the new-cd-docs branch March 27, 2025 14:19
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.

Update the documentation to describe the new CD process

3 participants