Skip to content

Expanded setup instructions - #51

Merged
Unisay merged 2 commits into
IntersectMBO:mainfrom
rober-m:main
Jul 23, 2025
Merged

Expanded setup instructions#51
Unisay merged 2 commits into
IntersectMBO:mainfrom
rober-m:main

Conversation

@rober-m

@rober-m rober-m commented Jul 18, 2025

Copy link
Copy Markdown
Contributor

Expanded setup instructions related to Nix and Docker, and added the option to use Demeter.

The new information is based on the Education team's plinth-dev-env development environment, which was previously used during the PPP and other training courses and events.

The objective of moving those instructions here is, in part, to be able to finally fully drop plinth-dev-env in favor of plinth-template as the "development environment of choice" for Plinth.

Pre-submit checklist:

  • Branch
    • Tests are provided (if possible)
    • Commit sequence broadly makes sense
    • Key commits have useful messages
    • Changelog fragments have been written (if appropriate)
    • Relevant tickets are mentioned in commit messages
    • Formatting, PNG optimization, etc. are updated
  • PR
    • (For external contributions) Corresponding issue exists and is linked in the description
    • Targeting master unless this is a cherry-pick backport
    • Self-reviewed the diff
    • Useful pull request description
    • Reviewer requested

Expanded setup instructions related to Nix and Docker, and added the option to use Demeter
@rober-m
rober-m marked this pull request as ready for review July 18, 2025 12:24
@rober-m

rober-m commented Jul 18, 2025

Copy link
Copy Markdown
Contributor Author

Hi @Unisay, I'd appreciate a review whenever you have the time. 🙏

@rober-m

rober-m commented Jul 18, 2025

Copy link
Copy Markdown
Contributor Author

Hi, @LukaKurnjek, as the original author of the instructions, feel free to take a look if you have the time. I tried to be as concise as possible and offloaded much of the original notes and instructions to their respective docs. I hope that's ok.

@Unisay
Unisay requested a review from Copilot July 18, 2025 12:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull Request Overview

This PR expands the setup instructions in the README to provide more detailed and organized guidance for setting up development environments. The changes restructure existing content into collapsible sections and add a new Demeter cloud development option.

  • Reorganized existing Nix and Docker setup instructions into collapsible details sections for better readability
  • Added comprehensive Demeter cloud development environment setup instructions
  • Enhanced Docker/Devcontainer instructions with more specific guidance for different use cases

Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@LukaKurnjek

Copy link
Copy Markdown

Looks OK to me. Feel free to merge it.

@Unisay
Unisay requested review from Unisay and zeme-wana July 22, 2025 07:45

@Unisay Unisay left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM!

@zeme-wana waiting for you to take a look too :-)

@Unisay
Unisay merged commit 020a37f into IntersectMBO:main Jul 23, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants