Skip to content

Commit

Permalink
Merge pull request #101 from philipp-meier/main
Browse files Browse the repository at this point in the history
fix overview descriptions and canvas button
  • Loading branch information
gernotstarke authored Oct 6, 2024
2 parents b866596 + 970bce2 commit 73ef563
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 20 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> currently available on [arc42.org](https://www.arc42.org)
Site is currently beeing built and served by [Netlify](https://netlify.com)
Site is currently being built and served by [Netlify](https://netlify.com)


### How does it work?
Expand Down
2 changes: 1 addition & 1 deletion _pages/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Read more at [systemsguild.eu](https://systemsguild.eu), [b-agile.de/en](https:/

### This site...

is maintained on Github, based upon Jekyll, Markdown and other open-source
is maintained on GitHub, based upon Jekyll, Markdown and other open-source
technology.

It's built using [Netlify](https://www.netlify.com/) and
Expand Down
6 changes: 3 additions & 3 deletions _pages/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ Please note: In case you contact us:
* we'll use your personal data (name, email)
only for the purpose of answering your request. It will not be stored, kept
or processed in sense of European General Data Protection Regulation [GDPR](https://en.wikipedia.org/wiki/General_Data_Protection_Regulation).
* you explicitely give your consent that your data will be used for the
* you explicitly give your consent that your data will be used for the
aforementioned objective.
* you explicitely acknowledge and consent that some of the contact options
* you explicitly acknowledge and consent that some of the contact options
make use of unencrypted communication channels - therefore your personal data
might be visible during transit.



* <a href="xmxaxixlxtxo:[email protected]" onmouseover="this.href=this.href.replace(/x/g,'');"><i class="fa fa-fw fa-envelope"></i>Email (our adress is spam-protected)</a>
* <a href="xmxaxixlxtxo:[email protected]" onmouseover="this.href=this.href.replace(/x/g,'');"><i class="fa fa-fw fa-envelope"></i>Email (our address is spam-protected)</a>

* via [<i class="fab fa-fw fa-github"></i>issue tracker](https://github.com/arc42/arc42-template/issues) at [https://github.com/arc42/arc42-template/issues](https://github.com/arc42/arc42-template/issues).
* on <i class="fab fa-fw fa-linkedin"></i>LinkedIn:
Expand Down
4 changes: 2 additions & 2 deletions _pages/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ various [formats]({{page.url}}#format-overview) for various tools. For an overvi

# File-based formats

These formats are generated based upon their AsciiDoc sources from the [Github repository](https://github.com/arc42/arc42-template).
These formats are generated based upon their AsciiDoc sources from the [GitHub repository](https://github.com/arc42/arc42-template).

{% assign formats = "docx|asciidoc|markdown|markdownMP|markdownStrict|markdownMPStrict|gitHubMarkdown|gitHubMarkdownMP|latex|html|rst|textile" | split: "|" %}
{% assign types = "plain|withhelp" | split: "|" %}
Expand Down Expand Up @@ -104,7 +104,7 @@ It is based upon an older version of the template - due to technical difficultie

* If you consider to use confluence, the [asciidoc2confluence](https://github.com/rdmueller/asciidoc2confluence) script might be helpful.

* There is also a [confluence plugin available from the atlassian market place](https://marketplace.atlassian.com/plugins/com.networkedassets.plugins.space-blueprint/server/overview).
* There is also a [confluence plugin available from the atlassian marketplace](https://marketplace.atlassian.com/plugins/com.networkedassets.plugins.space-blueprint/server/overview).

## Legacy Version (arc42 v6) for Confluence

Expand Down
2 changes: 1 addition & 1 deletion _pages/more.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ articles_feature:
- image_path: /images/publications/article-feature.png
alt: "Several magazines"
title: "Articles"
excerpt: "More than a hundred articles in various publications (aah - most if that in German)."
excerpt: "More than a hundred articles in various publications (aah - most of that in German)."
url: /articles
btn_label: "more ..."
btn_class: "btn--primary"
Expand Down
6 changes: 3 additions & 3 deletions _pages/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ arc42 answers the following two questions in a pragmatic way and can be tailored
<div class="flex row space-between">
<div class="flex column">
<strong>2. Constraints</strong><br>
<small>External systems & interfaces</small>
<small>Regulations and external constraints</small>
</div>
</div>
</a>
Expand All @@ -178,7 +178,7 @@ arc42 answers the following two questions in a pragmatic way and can be tailored
<div class="flex row space-between">
<div class="flex column">
<strong>3. Context & Scope</strong><br>
<small>Core ideas and solution approaches</small>
<small>External systems & interfaces</small>
</div>
</div>
</a>
Expand All @@ -187,7 +187,7 @@ arc42 answers the following two questions in a pragmatic way and can be tailored
<div class="flex row space-between">
<div class="flex column">
<strong>4. Solution Strategy</strong><br>
<small>Structure of source code, modularization (hierarchical)</small>
<small>Core ideas and solution approaches</small>
</div>
</div>
</a>
Expand Down
8 changes: 4 additions & 4 deletions _pages/principles-of-tech-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ Teams must constantly adapt (_maintain_) their documentation, so it remains corr
* If the answer to one of these questions is "no", then remove the corresponding part of the documentation. As everything is [version controlled](#sect-version-controlled), it would be available if needed later on.
* Optimize your documentation (not only your system!) for maintainability.
The section on [Easy to find](#sect-maintainable) contains numerous approaches that help to optimize maintainability.
* [Automate the generation of certain parts](#sect-automate-certain-parts) of your documentation..
* [Automate the generation of certain parts](#sect-automate-certain-parts) of your documentation.


<h3 id="sect-understandable">Req-3: Understandable</h3>
Expand Down Expand Up @@ -393,7 +393,7 @@ interested in.
Referenceable elements can be uniquely identified in the context of your
documentation. Instead of writing “see the diagram below” or “the table
above”, you should strive for “see diagram 5.2” or “the table 3.1”. You
can chose any numbering or referencing scheme you like, but you should
can choose any numbering or referencing scheme you like, but you should
use it consistently.

#### How to make documentation referenceable
Expand Down Expand Up @@ -548,7 +548,7 @@ coverage of automated (*living*) documentation.
> users can find the information that they need.
> [^hargisDevelopingQualityTechnical2004], p.213
This requirements relates to both the content of the documentation and
These requirements relate to both the content of the documentation and
to the documentation itself. In reality, documentation is often located
in access-controlled areas that are not covered by any search engine:
That means you have to know where to look for the documentation.
Expand Down Expand Up @@ -602,7 +602,7 @@ But in reality that’s not always as simple as it sounds:
- Documentation authors, especially from non-technical roles, might
not be able (or refuse to) use a VCS.

Therefore I propose the following strategy:
Therefore, I propose the following strategy:

- Ideally, add all documentation artifacts to a VCS, like `git`. Your
VCS should facilitate branching and merging artifacts. Additionally,
Expand Down
4 changes: 2 additions & 2 deletions _pages/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ about software architecture is hidden in single brains, scattered code
or simply lost.

Several typical problems hinder many software projects - which
arc42 can help to reduce or eliminate very effiently with low effort.
arc42 can help to reduce or eliminate very efficiently with low effort.

### Not Existing or Outdated
The first problem is missing or outdated documentation:
Expand All @@ -27,7 +27,7 @@ The first problem is missing or outdated documentation:

There's documentation, created somewhere in the past. Rumors say it had been
correct a long time ago, the original authors unknown or vanished. Such _historical_
artifacts only waste disk space and provide no value at alll, for nobody.
artifacts only waste disk space and provide no value at all, for nobody.



Expand Down
4 changes: 1 addition & 3 deletions assets/css/button.css
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,7 @@
margin-top: 10px;
}



.buttonCanvas {
width: 90vw;
width: 100%;
padding: 20px 0;
}

0 comments on commit 73ef563

Please sign in to comment.