Skip to content

reorg docs: Install section #772

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

fenekku
Copy link
Collaborator

@fenekku fenekku commented Jun 2, 2025

  • docs-reorg: refactor Install section

Notes

  • This reorganization pass makes more content changes than the previous ones.
  • The split between "containerized preview" and "local development" installation is made explicit
  • virtualenvs.md is moved to References
  • migrate.md (migrating data) is moved to Operate > Operations
  • debugging.md is moved to Operate > Add custom code
  • help.md is merged with troubleshoot.md (was too short to stand on its own)
  • consolidate user remarks to users.md
  • consolidate logging remarks to logging.md
  • enable the "caption" extension and use it for 1 image

Screenshots

Home
home_get_started

Section
overview_get_started

Site

https://fenekku.github.io/docs-invenio-rdm/

@fenekku fenekku force-pushed the reorg_docs_get_started branch 4 times, most recently from 17ad32c to 18e50d9 Compare June 6, 2025 17:26
@fenekku fenekku changed the title reorg docs get started reorg docs: Install section Jun 6, 2025
@fenekku fenekku force-pushed the reorg_docs_get_started branch from 18e50d9 to 7a7a1ae Compare June 6, 2025 17:36
@fenekku
Copy link
Collaborator Author

fenekku commented Jun 6, 2025

From discussions

tldr
More content, and potentially changes to installation would be needed to make this section shine.

Longer version
"Get started" was remarked as having no clear and immediate audience/goal as opposed to other sections. As such I kept "Install" instead. This is not 'yet' ideal, but with some future content changes we can make it work.

Lots of other popular self-hostable software use "Install" as a section header for how to deploy/host the software on your infrastructure.

The containerized preview content we have sort of does that. I've done a little more content editing there, but to really make it work, I think we should more clearly recommend/adopt an installation setup (a-la inveniordm-starter from @mfenner ).

This may introduce fuzziness around what goes in Install and what goes in Operate ops. To address that, we should emphasize that the Install section is to get from 0 to 1 instance. The "Operate" section should be about getting that 1 generic instance to your (reader's) personalized instance (both infrastructure wise and feature/customization-wise). It's about fleshing out that 1 instance.

Anyway, I think the content can do for now, but we definitely need more refinement of that as a whole at a project level.

PS:

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.

1 participant