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.

Sign up for GitHub

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

Jump to bottom

Feature/393 readme improvements #456

Merged
merged 70 commits into from
Mar 6, 2024
Merged

Feature/393 readme improvements #456

merged 70 commits into from
Mar 6, 2024

Commits on Feb 27, 2024

  1. chore(docs): #393: improvements and TODOs

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    f785ee8 View commit details
    Browse the repository at this point in the history

  2. chore(docs): #393: move "Vision and Mission Statement" and "What is t… 

    …he IRS?" to new section "Introduction"
    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    0d749c8 View commit details
    Browse the repository at this point in the history

  3. chore(docs): #393: link / update READMEs

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    96a5d2f View commit details
    Browse the repository at this point in the history

  4. chore(docs): #393: update READMEs

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    b840cc0 View commit details
    Browse the repository at this point in the history

  5. chore(docs): #393: Correct spelling

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    89547da View commit details
    Browse the repository at this point in the history

  6. chore(docs): #393: Update README for Tavern tests

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    0485e21 View commit details
    Browse the repository at this point in the history

  7. chore(docs): #393: Correct broken link

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    917c80e View commit details
    Browse the repository at this point in the history

  8. chore(docs): #393: Add back-link to main IRS README

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    a81e078 View commit details
    Browse the repository at this point in the history

  9. chore(docs): #393: Add FAQ.md and link mutually with README.md

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    e911a2a View commit details
    Browse the repository at this point in the history

  10. chore(docs): #393: Format link

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    8ec9686 View commit details
    Browse the repository at this point in the history

  11. chore(docs): #393: Add reference to LICENSE.md in README.md as

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    0c7d974 View commit details
    Browse the repository at this point in the history

  12. chore(docs): #393: Add reference to CODE_OF_CONDUCT.md in CONTRIBUTIN… 

    …G.md
    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    ae80eae View commit details
    Browse the repository at this point in the history

  13. chore(docs): #393: Deduplicate section "Contact" by referencing the "… 

    …Getting in Touch" section in the README.md
    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    c5d22b4 View commit details
    Browse the repository at this point in the history

  14. chore(docs): #393: Add further TODOs to address / clarify

    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    e1c4f09 View commit details
    Browse the repository at this point in the history

  15. chore(docs): #393: Add some inspiration to "General contribution to t… 

    …he project"

- link to discussion page concering documentation improvements
- link to inbox,backlog items labeled as documntation
    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    036e4b6 View commit details
    Browse the repository at this point in the history

  16. Merge remote-tracking branch 'origin/main' into chore/393_readme_impr… 

    …ovements
    @dsmf
    dsmf committed Feb 27, 2024
    Configuration menu
    Copy the full SHA
    bdaf845 View commit details
    Browse the repository at this point in the history

Commits on Feb 28, 2024

  1. chore(docs):[#393] Add README for .config folder

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    a30d28d View commit details
    Browse the repository at this point in the history

  2. chore(docs):[#393] Move section "Notice for Docker Image" down to hav… 

    …e easier diff with main
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    c5dfe2d View commit details
    Browse the repository at this point in the history

  3. chore(docs):[#393] Further improve / enhance section "Source Layout"

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    a3d476d View commit details
    Browse the repository at this point in the history

  4. chore(docs):[#393] Improve / enhance section "Installation"

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    eea3a1a View commit details
    Browse the repository at this point in the history

  5. chore(docs):[#393] Link FAQ

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    5698a2d View commit details
    Browse the repository at this point in the history

  6. chore(docs):[#393] Improve section "Licenses" 

    - use relative link to NOTICE.md
- add link to IRS LICENSE file
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    58e22dd View commit details
    Browse the repository at this point in the history

  7. chore(docs):[#393] Add sections "Reporting Bugs and Vulnerabilities" … 

    …and "Contributing" (with link to CONTRIBUTING.md)
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    69225fe View commit details
    Browse the repository at this point in the history

  8. chore(docs):[#393] Remove TODO code comments in the documentation 

    We track these remaining TODOs in the story on github.
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    50dc51a View commit details
    Browse the repository at this point in the history

  9. chore(docs):[#393] Improve section "Local Deployment" condering "Loca… 

    …l IRS API"
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    4375796 View commit details
    Browse the repository at this point in the history

  10. chore(docs):[#393] Unify handling of case in headings

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    a1020a0 View commit details
    Browse the repository at this point in the history

  11. chore(docs):[#393] Extract "Getting in Touch" to CONTACT.md and link … 

    …AUTHORS.md

(because this information is referenced from multiple places)
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    6f922fe View commit details
    Browse the repository at this point in the history

  12. chore(docs):[#393] Cleanup link titles

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    6eab8f5 View commit details
    Browse the repository at this point in the history

  13. chore(docs):[#393] Correct reference to ess-demo.py README

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    0a04e49 View commit details
    Browse the repository at this point in the history

  14. chore(docs):[#393] Cleanup

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    24d4cf4 View commit details
    Browse the repository at this point in the history

  15. chore(docs):[#393] Correct "IRS Load Tests" README

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    d1eecaa View commit details
    Browse the repository at this point in the history

  16. chore(docs):[#393] Improve formatting and wording of Insomnia REST re… 

    …quest collection README
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    1adef1d View commit details
    Browse the repository at this point in the history

  17. chore(docs):[#393] Formatting

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    2b0918d View commit details
    Browse the repository at this point in the history

  18. chore(docs):[#393] Extract section "Usage" to a dedicated file to kee… 

    …p the README clean
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    b67953c View commit details
    Browse the repository at this point in the history

  19. chore(docs):[#393] Remove obsolete sentence (already addressed in NOT… 

    …ICE.md)
    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    e791fdc View commit details
    Browse the repository at this point in the history

  20. chore(docs):[#393] Add section "Iteration Notes and Discussions"

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    4497a0b View commit details
    Browse the repository at this point in the history

  21. chore(docs):[#393] Clean link title

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    72c2f1d View commit details
    Browse the repository at this point in the history

  22. chore(docs):[#393] Move IRS request collection to subdirectory

    @dsmf
    dsmf committed Feb 28, 2024
    Configuration menu
    Copy the full SHA
    872f164 View commit details
    Browse the repository at this point in the history

Commits on Feb 29, 2024

  1. chore(docs):[#393] Reorder and enhance the FAQ

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    666dcb8 View commit details
    Browse the repository at this point in the history

  2. chore(docs):[#393] Some corrections and added links and references in… 

    … the architecture documentation
    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    0a4ac5a View commit details
    Browse the repository at this point in the history

  3. chore(docs):[#393] Add link to wiremock and testcontainers

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    e2ee4bd View commit details
    Browse the repository at this point in the history

  4. chore(docs):[#393] fix order in FAQ

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    5982d83 View commit details
    Browse the repository at this point in the history

  5. chore(docs):[#393] some formatting in README

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    723127d View commit details
    Browse the repository at this point in the history

  6. chore(docs):[#393] Add section / reference concerning monitoring

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    ba31187 View commit details
    Browse the repository at this point in the history

  7. chore(docs):[#393] Add section / reference concerning tests

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    22d8ca6 View commit details
    Browse the repository at this point in the history

  8. chore(docs):[#393] Improve section "Integration Tests"

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    9a17e96 View commit details
    Browse the repository at this point in the history

  9. chore(docs):[#393] Improvements concerning "Create a Release"

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    7d5412a View commit details
    Browse the repository at this point in the history

  10. chore(docs):[#393] Unify handling of case in headings

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    8eeb322 View commit details
    Browse the repository at this point in the history

  11. chore(docs):[#393] Correct spelling, unify case of trademark, improve… 

    … link titles
    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    770e81f View commit details
    Browse the repository at this point in the history

  12. chore(docs):[#393] Cleanup spaces

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    bd5aead View commit details
    Browse the repository at this point in the history

  13. chore(docs):[#393] Extract section "Tests" to separate file and add n… 

    …ote on stress tests
    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    eec7d3b View commit details
    Browse the repository at this point in the history

  14. Merge remote-tracking branch 'origin/main' into chore/393_readme_impr… 

    …ovements
    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    8fd32ac View commit details
    Browse the repository at this point in the history

  15. chore(docs):[#393] Remove duplicate line

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    9e94015 View commit details
    Browse the repository at this point in the history

  16. chore(docs):[#393] Improve readability, add coverage badge

    @dsmf
    dsmf committed Feb 29, 2024
    Configuration menu
    Copy the full SHA
    3aa45a9 View commit details
    Browse the repository at this point in the history

Commits on Mar 1, 2024

  1. chore(docs):[#393] Add note concerning GitHub issue number in CHANGEL… 

    …OG entries

as discussed in parking lot 2024-03-01
    @dsmf
    dsmf committed Mar 1, 2024
    Configuration menu
    Copy the full SHA
    0b88ed3 View commit details
    Browse the repository at this point in the history

Commits on Mar 4, 2024

  1. Merge pull request #799 from eclipse-tractusx/main 

    Sync with upstream
    @ds-jhartmann
    ds-jhartmann authored Mar 4, 2024
    Configuration menu
    Copy the full SHA
    a74d252 View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into chore/393_readme_improvements 

    # Conflicts:
#	docs/src/docs/arc42/glossary.adoc
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    8f2710c View commit details
    Browse the repository at this point in the history

  3. feat(impl):[#393] Improved glossary by splitting abbreviation and ter… 

    …m into separate columns
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    c07fcd9 View commit details
    Browse the repository at this point in the history

  4. chore(docs):[#393] Unify case in glossary

    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    b899dcc View commit details
    Browse the repository at this point in the history

  5. chore(docs):[#393] Add link to .config README

    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    61d6509 View commit details
    Browse the repository at this point in the history

  6. chore(docs):[#393] Add ds-psosnowski to AUTHORS.md

    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    b785eb6 View commit details
    Browse the repository at this point in the history

  7. chore(docs):[#393] Removed catenax-ng 

    as suggested by mkanal in review https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511340553
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    bf6a959 View commit details
    Browse the repository at this point in the history

  8. chore(docs):[#393] improvement 

    as suggested by mkanal in https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511346846
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    c7746ac View commit details
    Browse the repository at this point in the history

  9. chore(docs):[#393] Add link to USAGE.md 

    based on comment from ds-jhartmann https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511381420
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    6996e27 View commit details
    Browse the repository at this point in the history

  10. chore(docs):[#393] Remove link to catena-ng 

    as mentioned by ds-mkanal in https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511377161
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    5a87e99 View commit details
    Browse the repository at this point in the history

  11. chore(docs):[#393] Fixed glossary table 

    as suggested by ds-jhartmann in https://github.com/eclipse-tractusx/item-relationship-service/pull/456/files#r1511369743
    @dsmf
    dsmf committed Mar 4, 2024
    Configuration menu
    Copy the full SHA
    e835a9c View commit details
    Browse the repository at this point in the history

Commits on Mar 5, 2024

  1. Update irs-cucumber-tests/README.md 

    Co-authored-by: ds-mkanal <100209308+mkanal@users.noreply.github.com>
    @dsmf @mkanal
    dsmf and mkanal authored Mar 5, 2024
    Configuration menu
    Copy the full SHA
    89e38ef View commit details
    Browse the repository at this point in the history

  2. chore(docs):[#393] Remove link to spring boot documentation that incl… 

    …udes version
    @dsmf
    dsmf committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    8aec98d View commit details
    Browse the repository at this point in the history

  3. Merge remote-tracking branch 'origin/feature/393_readme_improvements'… 

    … into chore/393_readme_improvements
    @dsmf
    dsmf committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    900ef0b View commit details
    Browse the repository at this point in the history

  4. chore(docs):[#393] Fix typo

    @dsmf
    dsmf committed Mar 5, 2024
    Configuration menu
    Copy the full SHA
    0e449de View commit details
    Browse the repository at this point in the history