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 docs to develop dashboard and shell apps within ood itself #912

Merged
merged 10 commits into from
Jan 19, 2024

Conversation

Oglopf
Copy link
Contributor

@Oglopf Oglopf commented Dec 12, 2023

Modify this link to include the branch name, and possibly the page this PR modifies:

https://osc.github.io/ood-documentation-test/ood-in-ood-dev/

Add your description here
This PR adds sections on how to use the sandbox capability of OOD to do development work, from within the production system, on a separate dev dashboard or shell app.

This also includes tips in presenting all this in how you can set new environment variables for this dev dashboard along with how to set your very own configuration directory for the dev dashboard as well.

Similarly, the shell app entry shows a user how to make their own dev shell, how to make changes to this shell, and then how to rebuild correctly to see the changes.

I'd like to add some more to this such as work on the Files app as well, the goal being to show the world how we do this internally at OSC.

@Oglopf
Copy link
Contributor Author

Oglopf commented Dec 12, 2023

To-do

  • add some pictures for the dev dashboard with color variation
  • cleanup wording
  • a couple more advanced examples around customization.
  • the shell app page is are bones. I'd like to enrich it a bit still and walk through a rebuild when changes are made

To be clear, the goal here is that these docs would largely be used for onboarding and community dev work. Now, if a new dev comes on board, we can point them to our docs and get them working rather than have many places with many tasks which we expect them to ingest and compose correctly in their head. But, that's just analysis for anlysis' sake. This gives the moves up front, the algebra to build is right there and hopefully this creates a much faster on ramping.

This also let's user's who've fallen into the usual trap of "I started this on a VM, showed it to a researcher, and next thing knew it was a service!" problem. Now, they can at least have a dev environment to work in rather than posting every question on the Discourse, thereby freeing us up more as well.

@Oglopf Oglopf marked this pull request as ready for review January 17, 2024 20:05
@Oglopf
Copy link
Contributor Author

Oglopf commented Jan 17, 2024

I think I'm happy with this at this point and good with a review and pulling it in. We can enrich the entries more if desired later, but I think this at least gives good fundamentals on how to do this type of work on ood.

@Oglopf Oglopf merged commit 87f1fe9 into develop Jan 19, 2024
1 check passed
@Oglopf Oglopf deleted the ood-in-ood-dev branch January 19, 2024 16:39
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.

2 participants