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

docs: publish architectural decision records #2301

Merged
merged 5 commits into from Nov 26, 2022
Merged

Conversation

irinaschubert
Copy link

@irinaschubert irinaschubert commented Nov 24, 2022

Issue Number: DEV-

Pull Request Checklist

Basic Requirements

Please check if your PR fulfills the following requirements:

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

  • Bugfix: represents bug fixes
  • Refactor: represents production code refactoring
  • Feature: represents a new feature
  • Documentation: documentation changes (no production code change)
  • Chore: maintenance tasks (no production code change)
  • Style: styles updates (no production code change)
  • Test: all about tests: adding, refactoring tests (no production code change)
  • Other... Please describe:

Does this PR introduce a breaking change?

  • Yes
  • No

Does this PR change client-test-data?

  • Yes (don't forget to update the JS-LIB team about the change)
  • No

Other information

It was decided that ADRs should be published on our official documentation website.

@irinaschubert irinaschubert self-assigned this Nov 24, 2022
@codecov
Copy link

codecov bot commented Nov 24, 2022

Codecov Report

Base: 86.95% // Head: 86.95% // No change to project coverage 👍

Coverage data is based on head (6f8eb98) compared to base (bfe578a).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2301   +/-   ##
=======================================
  Coverage   86.95%   86.95%           
=======================================
  Files         242      242           
  Lines       28102    28102           
=======================================
  Hits        24435    24435           
  Misses       3667     3667           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@irinaschubert irinaschubert marked this pull request as ready for review November 24, 2022 14:03
Copy link
Collaborator

@BalduinLandolt BalduinLandolt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Not much of value to add from my side.
(There is of course much to improve in the docs, but that would be out of scope for this task.)

But it's impossible for me to keep track of all the links that have changed. Did you run the docs locally and click around to see if stuff still works?

docs/01-introduction/what-is-dsp.md Outdated Show resolved Hide resolved
docs/02-dsp-ontologies/introduction.md Outdated Show resolved Hide resolved
docs/03-endpoints/api-admin/introduction.md Outdated Show resolved Hide resolved
docs/03-endpoints/api-util/health.md Outdated Show resolved Hide resolved
docs/03-endpoints/index.md Outdated Show resolved Hide resolved
@irinaschubert
Copy link
Author

irinaschubert commented Nov 24, 2022

LGTM. Not much of value to add from my side. (There is of course much to improve in the docs, but that would be out of scope for this task.)

But it's impossible for me to keep track of all the links that have changed. Did you run the docs locally and click around to see if stuff still works?

@BalduinLandolt Thanks for your feedback! It's really hard to stop improving it, once you started... So, yes, there could be done much more to improve these docs!
I did run it locally and clicked around. mkdocs shows warnings if internal links are not working or if there are files not referenced in the nav file. I solved all these warnings, so I hope it is fine.

@irinaschubert irinaschubert merged commit be6bcd0 into main Nov 26, 2022
@irinaschubert irinaschubert deleted the wip/fix-adr-file branch November 26, 2022 09:59
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

Successfully merging this pull request may close these issues.

None yet

3 participants