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

Catalog docs vs ABCD-J docs #12

Closed
tmheunis opened this issue Feb 5, 2024 · 1 comment
Closed

Catalog docs vs ABCD-J docs #12

tmheunis opened this issue Feb 5, 2024 · 1 comment

Comments

@tmheunis
Copy link
Contributor

tmheunis commented Feb 5, 2024

While creating the user docs for the catalog in order to provide instructions for how users can contribute to the catalog, this question came up: should there be ABCD-J level docs, and should the catalog docs be a subset of that? Or should we keep the catalog docs to the catalog and leave other higher-level decisions for future consideration?

If we decide to do top-level docs, with catalog instructions forming a part of that, we should probably have a separate repo in the abcd-j org for that, and then the content of user-docs in the current repo should move there.

@jsheunis
Copy link
Collaborator

This has been resolved as follows in the past weeks:

  • the catalog sources are located in the catalog subdirectory of this repo, which is where the data.abcd-j.de site is deployed from (not with github pages anymore)
  • the documentation is located in docs subdirectory (which was previously used for the catalog sources), where github pages deploys docs to rdm.abcd-j.de (custom domain)
  • the RDM docs are catalog-level at the moment and could include other RDM-related content in future (e.g. a "For developers" section that details how to update the catalog)
  • ABCD-J project-level docs are currently considered too general to have, but might be added in future if the need arises

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

No branches or pull requests

2 participants