Unify stable and beta release instructions and fix some issues #164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
daikema
reviewed
Jan 29, 2024
docs/src/introduction.rst
Outdated
| @@ -10,14 +10,16 @@ The CARTA controller provides a simple dashboard which authenticates users and a | |||
| Dependencies | |||
| ------------ | |||
|
|
|||
| To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it. You should use the ``v4.1.0`` tag of `the CARTA backend <https://github.com/CARTAvis/carta-backend>`_. | |||
| To allow the controller to serve CARTA sessions, you must give it access to an executable CARTA backend, which can be either a compiled executable or a container. If you want to use a non-standard version of the CARTA frontend, you must also build it, and adjust the controller configuration to point to it. | |||
|
|
|||
| By default, the controller runs on port 8000. It should be run behind a proxy, so that it can be accessed via HTTP and HTTPS. | |||
|
|
|||
| MongoDB is required for storing user preferences, layouts and (in the near future) controller metrics. | |||
There was a problem hiding this comment.
Suppose this is now being used for shared workspaces as well ... though perhaps that should be done as a separate set of commits?
There was a problem hiding this comment.
Any excuse to add an Oxford comma. 😁
confluence
added a commit
that referenced
this pull request
Jan 31, 2024
* remove username sanitization (#161) * Add required default config file for Read The Docs * Updates for v4.1 release (#163) * version text adjustment * version bump to 4.0 * Add required default config file for Read The Docs * npm audit fix * Address deprecation warnings during backend run * Updates for v4.1 * fix output * Closing my editor reminded me I forgot to save this file --------- Co-authored-by: veggiesaurus <accomrie@gmail.com> Co-authored-by: Adrianna Pińska <adrianna.pinska@gmail.com> * Couple overlooked things * Unify stable and beta release instructions and fix some issues (#164) * Unify stable and beta release instructions and fix some issues * Fixed incorrect beta location in /opt * Mention COPR in general installation section * fixed url format * mention workspaces --------- Co-authored-by: Angus Comrie <accomrie@gmail.com> Co-authored-by: David Aikema <daikema@users.noreply.github.com> Co-authored-by: David Aikema <david.aikema@uct.ac.za>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Maintaining divergent instructions for the stable and beta releases in different branches is not sustainable -- we keep incorrectly overwriting some or all of the version-specific instructions during merges (e.g. right now the 4.1 instructions are mostly for the stable release in both the release branch and in dev, except that one beta reference in the general instructions hasn't been updated, and the RPM-based guide refers to a non-existent install location in
/opt). This system also increases the risk of users stumbling onto the wrong version of the instructions and installing the wrong version or a mismatched set of components by mistake.I propose that we explicitly refer to both the stable and beta version throughout (we can rewrite this once and not have to mess around with it in future). I think that this makes it clear what the options are and which is which.
This may also simplify the management of branches on Read The Docs. We should remove the previous release branches, since we don't support them and it isn't currently even possible to install those releases using the instructions provided. Right now I think we only need the 4.0 release. When we do the 5.0-beta release we can make a 5.0 branch and add that (but keep
latestpointing to 4.0), so that any 5.0-specific changes which don't apply to 4.0 go there. When we do the 5.0 release we can remove 4.0 and updatelatest. I guess that we should keepdevas well, so that we have a published version of changes to the upcoming release before we make the release branch. Does that make sense?In this PR I have unified the version-specific instructions, assuming that most users will be interested in installing the stable version. I have also removed a specific version string from the introduction (that's too much detail for that section) and added more prominent links to both step-by-step pages from both the introduction and the installation overview (we've had problems before with people trying to use the sparse installation instructions as a complete guide).
I intend to backport this into the 4.0 release branch.