archi-modelrepository-plugin icon indicating copy to clipboard operation
archi-modelrepository-plugin copied to clipboard

Edit Git repository files such as README.md from within Archi

Open samperd opened this issue 5 years ago • 1 comments

User Story

As an archi tool modeler I want to edit various markdown documents from the git repository from within Archi So that I can manage both models and supporting repository management tasks within Archi

Current Situation

Currently you have to use an external editor or the editor of the git repository to create, update and manage external markdown files such as:

  • README.md
  • CHAGELOG.md (Could be autogenerated by Archi?)
  • CONTRIBUTING.md
  • LICENSE.md

Implementation Details

  • Could we add another "Folder" called "Repository" to hold top level markdown documents?
  • could we add supporting "Documentation folder" in the model to represent a "Documentation" folder in the git repository?
  • what if we could even use the MAIN PURPOSE model element to essentially by the README.md. So when you update the Purpose section you update the README.

samperd avatar May 31 '19 15:05 samperd

It would be great, if entity attribute "Documentation" could be implemented as markdown file, or even imported via URL into model.

So "Documentation" of Model itself could be implemented and edited as markdown document for example.

WatchTh1 avatar Jun 11 '19 18:06 WatchTh1