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
Updates to documentation #3457
Updates to documentation #3457
Conversation
@mathemancer please double check my reasoning here, that's the main thing I'm asking you to review. @seancolsen also added you as a reviewer in case you wanted to look at the index page changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with (2), but (1) isn't correct. If you want to use a specific DB server for the internal (Django) DB, you still set that up using environment variables. This section should perhaps be clarified, but it shouldn't be removed.
@mathemancer Thanks for the feedback. As discussed on our call yesterday, I've:
I decided not to change the build from source page because Set up the database > Step 3 already documents creating the internal database, and Install the Mathesar application > Step 2 also documents setting the environment variables. I'm not sure what we could add there. |
@kgodey I think this PR should target the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
Fixes #3428
This PR makes the following changes:
Reasoning for page removal
The page (see live version) attempted to document two things:
(1) How to set up a Mathesar internal database if you're connecting to an external DB
These steps were out of date anyway, since they referred to configuring the DB via environment variables. Also, it is my understanding that we don't need to perform any steps after the new DB connection UI work in 0.1.4 and that we'll create the internal database automatically. So I removed it.
(2) How to configure Mathesar to point at a database on the host server if you're using Docker
My first instinct was to move this to the "Optional configurations" section of the Docker compose installation, and I spent some time doing that and making the documentation more concise. Then I realized that
It didn't seem like it was worth cleaning up or having this documentation, so I removed it.
Checklist
Update index.md
).develop
branch of the repositoryvisible errors.
Developer Certificate of Origin
Developer Certificate of Origin