Summary

Add a wizard for managing the installation of Review Board.

Review Request #13477 — Created Jan. 3, 2024 and submitted Jan. 12, 2024, 4:18 p.m.

Information

Owner

chipx86

Repository

rbinstall

Branch

master

Bugs

Depends On

~~13476~~

Blocks

13478

Reviewers

Groups

reviewboard

People

Description

The new wizard walks the user through installing Review Board via the
following steps:

Showing an overview of the install process, along with the system and
target version information, and confirming before moving on.
Displays details on the Site vs. Install Directories, asks the user
for the install location for the virtualenv, and validates the path.
Shows the commands that will be run and then prompts for confirmation
before installing.
Performs the install, streaming results and showing progress.
Asks the user if they want to create a new sitedir or import one, and
walks the user through those choices.
If requested, executes rb-site install to help the user install the
site.
Finishes up with a success or error result, and any further steps
that may be needed.

This makes the install process very simple, and gives users just enough
information to make the right choices.

Right now, the wizard is not invoked. That will be handled in the next
change.

Testing Done

Extensively tested the wizard in both interactive and unattended modes.
Tested validation and error handling, and different install state for
installation options. Completed several installs.

Commits

Summary	ID
Add a wizard for managing the installation of Review Board. The new wizard walks the user through installing Review Board via the following steps: 1. Showing an overview of the install process, along with the system and target version information, and confirming before moving on. 2. Displays details on the Site vs. Install Directories, asks the user for the install location for the virtualenv, and validates the path. 3. Shows the commands that will be run and then prompts for confirmation before installing. 4. Performs the install, streaming results and showing progress. 5. Asks the user if they want to create a new sitedir or import one, and walks the user through those choices. 6. If requested, executes `rb-site install` to help the user install the site. 7. Finishes up with a success or error result, and any further steps that may be needed. This makes the install process very simple, and gives users just enough information to make the right choices. Right now, the wizard is not invoked. That will be handled in the next change.	828b3770c9e9302a5c7472ad4a371a23b51c9982

Summary

Add a wizard for managing the installation of Review Board.

The new wizard walks the user through installing Review Board via the following steps: 1. Showing an overview of the install process, along with the system and target version information, and confirming before moving on. 2. Displays details on the Site vs. Install Directories, asks the user for the install location for the virtualenv, and validates the path. 3. Shows the commands that will be run and then prompts for confirmation before installing. 4. Performs the install, streaming results and showing progress. 5. Asks the user if they want to create a new sitedir or import one, and walks the user through those choices. 6. If requested, executes `rb-site install` to help the user install the site. 7. Finishes up with a success or error result, and any further steps that may be needed. This makes the install process very simple, and gives users just enough information to make the right choices. Right now, the wizard is not invoked. That will be handled in the next change.

828b3770c9e9302a5c7472ad4a371a23b51c9982

Files

Issues

Description	From	Last Updated
I feel like we should specify that this will exit the installer, and that they'd have to continue this part …	maubin	Jan. 6, 2024, 10:06 p.m.
We should link to the documentation.	maubin	Jan. 6, 2024, 10:13 p.m.
We should add another sentence here to refer them to the documentation for setting up a site directory, and link …	maubin	Jan. 6, 2024, 10:13 p.m.
Per my comments above, if we add specific links to the documentation I think we could get rid of this …	maubin	Jan. 6, 2024, 10:14 p.m.
line too long (100 > 79 characters) Column: 80 Error code: E501	reviewbot	Jan. 6, 2024, 10:45 p.m.

flake8 passed.

JSHint passed.

rbinstall/wizard.py (Diff revision 1)

The issue has been resolved. Show all issues

I feel like we should specify that this will exit the installer, and that they'd have to continue this part of the installation on their own. Could say something like "Press Control-C if you want to exit the installer and setup your Site Directory later on your own.". Also I have a comment below that mentions how we should link to the documentation for setting up a site directory, we should do that here too before the installer exits.

rbinstall/wizard.py (Diff revision 1)

The issue has been resolved. Show all issues

We should link to the documentation.

chipx86 Jan. 6, 2024, 10:45 p.m.

We should. I'm going to put this in the introductory paragraph and then in the conclusions, so they can learn more before they make a choice, and then when it's time for next steps.

rbinstall/wizard.py (Diff revision 1)

The issue has been resolved. Show all issues

We should add another sentence here to refer them to the documentation for setting up a site directory, and link to this documentation.

rbinstall/wizard.py (Diff revision 1)

The issue has been resolved. Show all issues

Per my comments above, if we add specific links to the documentation I think we could get rid of this generic "Refer to the documentation to finish setting up" sentence. That way we're not repeating ourselves, and people will be able to easily find what the next steps are, depending on whether the site directory was created or not. We should still keep the "Contact [support_link] if you need assistance" though.

Change Summary:


Added links to the Creating a Review Board Site docs in the "Your Site Directory" summary and in the import/create success/failed instructions.
Fixed some capitalization for "site directory" -> "Site Directory," for consistency.
Removed a double support message for imports.

Commits:

	Summary	ID
	Add a wizard for managing the installation of Review Board. The new wizard walks the user through installing Review Board via the following steps: 1. Showing an overview of the install process, along with the system and target version information, and confirming before moving on. 2. Displays details on the Site vs. Install Directories, asks the user for the install location for the virtualenv, and validates the path. 3. Shows the commands that will be run and then prompts for confirmation before installing. 4. Performs the install, streaming results and showing progress. 5. Asks the user if they want to create a new sitedir or import one, and walks the user through those choices. 6. If requested, executes `rb-site install` to help the user install the site. 7. Finishes up with a success or error result, and any further steps that may be needed. This makes the install process very simple, and gives users just enough information to make the right choices. Right now, the wizard is not invoked. That will be handled in the next change.	69176336ba890fbec9974b545ec027fcff3300e1
	Add a wizard for managing the installation of Review Board. The new wizard walks the user through installing Review Board via the following steps: 1. Showing an overview of the install process, along with the system and target version information, and confirming before moving on. 2. Displays details on the Site vs. Install Directories, asks the user for the install location for the virtualenv, and validates the path. 3. Shows the commands that will be run and then prompts for confirmation before installing. 4. Performs the install, streaming results and showing progress. 5. Asks the user if they want to create a new sitedir or import one, and walks the user through those choices. 6. If requested, executes `rb-site install` to help the user install the site. 7. Finishes up with a success or error result, and any further steps that may be needed. This makes the install process very simple, and gives users just enough information to make the right choices. Right now, the wizard is not invoked. That will be handled in the next change.	828b3770c9e9302a5c7472ad4a371a23b51c9982

Diff:

Revision 2 (+1336 -18)

Show changes

	rbinstall/process.py
	rbinstall/wizard.py

Added Files:

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

rbinstall/wizard.py (Diff revision 2)
The issue has been resolved. Show all issues
```
line too long (100 > 79 characters)

Column: 80
Error code: E501
```

Ship it!

```
Ship It!
```

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to master (1a324b7)