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

Documentation setup #12

Open
RieksJ opened this issue Aug 18, 2022 · 0 comments
Open

Documentation setup #12

RieksJ opened this issue Aug 18, 2022 · 0 comments
Labels
type: admin This issue requires an action by an admin. type: terminology

Comments

@RieksJ
Copy link
Contributor

RieksJ commented Aug 18, 2022

It seems to me that architecture (related) documents SHOULD have a single point of entry for any reader, be properly readable/understandable, and be easily maintainable.

Since there is already a git repo TechArch, I suggest to use this repo for

  • maintaining all of its documentation (versioned if need be);
  • develop the TechArch specific terminology (as per the guidance of CTWG);
  • have github actions turn the documentation into a nicely rendered static website;
    (which is basically a setup that is similar to e.g. that of the eSSIF-Lab framework).

My guess is that setting it up would require a bit of effort (and a person that knows how to do that), but maintaining a once-installed structure should be doable (I do that for eSSIF-Lab).

The benefits I see are that

  • it achieves the requirements of the first sentence in this post;
  • it can start using the tools/CTWG toolbox as they become available;
  • it will make the Architecture have a professional look and feel (don't underestimate the effects of that).
@talltree talltree added type: admin This issue requires an action by an admin. type: terminology labels Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: admin This issue requires an action by an admin. type: terminology
Projects
None yet
Development

No branches or pull requests

3 participants