rdmorganiser / rdmorganiser/rdmo-docs

Missing guidance for maintainers

Open
#1 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Makefile
Stars
0
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Dear @jochenklar

as discussed in the train on Friday, I'm opening an issue for this...

After being enlighted by the workshop about the correct usage of the catalog, etc. I want to rise an issue and complain about missing documentation for maintainers of an RDMO instance.

Currently, there is a lot of technical documentation available, but the different pitfalls while trying to setup an instance for production use is missing a lot of details.

I am willing to contribute here as we go on within FZJ. (Mentioning @bronger)

Cheers,
Oliver

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files, tests, or documentation entry points. Start by reviewing the existing technical documentation and the production setup guidance for an RDMO instance, including the catalog usage pitfalls mentioned in the report. Done means maintainers have clear, practical documentation covering those production setup details.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.