Git Product home page Git Product logo

structurizr.github.io's People

Contributors

simonbrowndotje avatar

Stargazers

avatar avatar avatar avatar avatar avatar

Watchers

avatar

Forkers

drrdrew shahabganji don-attilio yagosvl

structurizr.github.io's Issues

Can ADRs be written in AsciiDoc format?

Description

At the moment of issue creation the file https://github.com/structurizr/structurizr.github.io/blob/b59cba34418cb2298ed0e9b8b5e52b3c9de4b0fb/ui/decisions/index.md contains line

In Structurizr, each ADR has an ID, title, date and status (e.g. "Proposed", "Accepted", "Superseded", etc), along with unstructured content written using Markdown or AsciiDoc. ADRs can either be created manually, or imported from tools like [adr-tools](https://github.com/npryce/adr-tools).

This line should be changed to

In Structurizr, each ADR has an ID, title, date and status (e.g. "Proposed", "Accepted", "Superseded", etc), along with unstructured content written using Markdown. ADRs can either be created manually, or imported from tools like [adr-tools](https://github.com/npryce/adr-tools).

According to https://github.com/structurizr/structurizr.github.io/blob/main/dsl/adrs.md and source for parser https://github.com/structurizr/import/blob/595fa3dfe26dc38803b1adcb0caf4052762e0fc6/src/main/java/com/structurizr/importer/documentation/AdrToolsDecisionImporter.java the only way is to use .md

Steps to reproduce

Open doc at https://github.com/structurizr/structurizr.github.io/blob/b59cba34418cb2298ed0e9b8b5e52b3c9de4b0fb/ui/decisions/index.md or https://docs.structurizr.com/ui/decisions/.

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response

Fix the link to AdrToolsDecisionImporter in ADRs doc

Description

Current dsl/adrs doc contains broken link to AdrToolsDecisionImporter (https://github.com/structurizr/documentation/blob/main/src/main/java/com/structurizr/documentation/importer/AdrToolsDecisionImporter.java)

should be

https://github.com/structurizr/import/blob/main/src/main/java/com/structurizr/importer/documentation/AdrToolsDecisionImporter.java

Steps to reproduce

Open the doc and check the link

Screenshot

No response

Code sample

No response

Configuration

No response

Severity

Minor

Priority

I have no budget and there's no rush, please fix this for free

More information

No response

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.