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

767 new tom creation documentation #1063

Merged
merged 8 commits into from
Oct 23, 2024
Merged

Conversation

jchate6
Copy link
Contributor

@jchate6 jchate6 commented Oct 1, 2024

This adds a variety of minor documentation changes.

@jchate6 jchate6 linked an issue Oct 1, 2024 that may be closed by this pull request
47 tasks
::

pip install dataclasses

We recommend using a `virtual
Copy link
Contributor

Choose a reason for hiding this comment

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

As long as we're editing these docs, can we be more emphatic about this recommendation? For example say, "strongly recommend", or "urge you to use...", or "you'd be silly not to use...". Something like that?

@@ -82,7 +75,8 @@ that it looks like this:


Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to explain what's happening here and to also mention not to do this on a project that is already a TOMToolkit-based TOM? For example, say something like: "The tom_setup app adds a single management command (tom_setup) to your Django project. When run (see below) the tom_setup management command basically transforms your Django project into a TOMToolkit project by removing itself and adding the base TOMToolkit apps (i.e tom_targets, tom_observations, tom_dataproducts, etc) to your INSTALLED_APPS list."

@jchate6
Copy link
Contributor Author

jchate6 commented Oct 15, 2024

@phycodurus would you like me to make these changes, or would you like to push a commit for these?

@jchate6 jchate6 merged commit 5f7ecf2 into dev Oct 23, 2024
25 checks passed
@jchate6 jchate6 deleted the 767-new-tom-creation-documentation branch October 23, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Review of new TOM creation process and documentation
2 participants