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

Add Debug image docs #3513

Merged
merged 1 commit into from Mar 25, 2024
Merged

Add Debug image docs #3513

merged 1 commit into from Mar 25, 2024

Conversation

mathemancer
Copy link
Contributor

This adds a page to the docs describing our new debug-enabled docker image, and its use.

Technical details

The image in question is the same as the production docker image, except both Gunicorn and Django debugging are enabled. It's designed to let us help users more easily with their docker-based Mathesar setups.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the develop branch of the repository
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@mathemancer mathemancer changed the base branch from develop to 0.1.6 March 25, 2024 15:27
@mathemancer
Copy link
Contributor Author

@pavish I know you don't have much context here, but I thought you could look through and make sure these new docs are at least coherent since @Anish9901 and @seancolsen are out at the moment.

@mathemancer mathemancer added this to the v0.1.6 milestone Mar 25, 2024
@mathemancer mathemancer added the pr-status: review A PR awaiting review label Mar 25, 2024
Copy link
Member

@pavish pavish left a comment

Choose a reason for hiding this comment

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

Looks good to me

Copy link
Member

@Anish9901 Anish9901 left a comment

Choose a reason for hiding this comment

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

Looks good @mathemancer, I am assuming that we'd need to build this image each time we make a release. So, It would be good to document the build commands under the release process in the wiki. We would also require building and publishing this image to docker hub for this release, could you take responsibility for that?

@pavish pavish merged commit dfaea91 into 0.1.6 Mar 25, 2024
39 checks passed
@pavish pavish deleted the debug_image_docs branch March 25, 2024 21:11
@mathemancer
Copy link
Contributor Author

Looks good @mathemancer, I am assuming that we'd need to build this image each time we make a release. So, It would be good to document the build commands under the release process in the wiki. We would also require building and publishing this image to docker hub for this release, could you take responsibility for that?

Yep, will do.

@kgodey
Copy link
Contributor

kgodey commented Mar 26, 2024

Yep, will do.

@mathemancer I added Basecamp tasks for:

  • Documenting the process for publishing debug images (to the 0.1.6 release project)
  • Actually publishing debug images (to the 0.1.6, 0.1.7 release projects, as well as the release template)

Let me know if that seems okay or if there needs to be more or less tracking.

@seancolsen seancolsen mentioned this pull request Mar 27, 2024
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-status: review A PR awaiting review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants