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

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

Open
samperd opened this issue May 31, 2019 · 1 comment
Open

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

samperd opened this issue May 31, 2019 · 1 comment

Comments

@samperd
Copy link

samperd commented May 31, 2019

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.
@Phillipus Phillipus transferred this issue from archimatetool/archi May 31, 2019
@WatchTh1
Copy link

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.

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