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

Documentation of the SCS Hardware Landscape #277

Merged
merged 13 commits into from
Dec 3, 2024
Merged

Documentation of the SCS Hardware Landscape #277

merged 13 commits into from
Dec 3, 2024

Conversation

scoopex
Copy link
Contributor

@scoopex scoopex commented Nov 26, 2024

Add some documentation which provides a high-level overview.

Signed-off-by: Marc Schöchlin <[email protected]>
@scoopex scoopex marked this pull request as draft November 26, 2024 11:10
Signed-off-by: Marc Schöchlin <[email protected]>
@scoopex scoopex changed the title Rework headings Documentation of the SCS Hardware Landscape Nov 26, 2024
Signed-off-by: Marc Schöchlin <[email protected]>
@scoopex scoopex marked this pull request as ready for review November 26, 2024 14:26
@scoopex scoopex requested a review from garloff November 26, 2024 14:27
@scoopex scoopex requested review from fkr and removed request for garloff November 29, 2024 11:25
Comment on lines +23 to +24
From 1 January 2025, the environment will be operated by [forum SCS-Standards](https://scs.community/2024/10/23/osba-forum-scs-standards/)
and the participating companies.
Copy link
Member

Choose a reason for hiding this comment

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

Not really sure why this needs to be part of the documentation. This is content better suited for a blogpost.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, @maxwolfs , @bitkeks and I decided at the time that it would be a good idea to create a dedicated page for the turnkey solution in the SCS Hardware Landscape variant to show an example of what a turnkey solution installation looks like.

@fkr
Copy link
Member

fkr commented Nov 29, 2024

Actually the comment that I made to the one item within the document applies to the whole document.
I don't quite understand, why this is a documentation piece and not a blogpost.
I tried to apply the diataxis framework to this document and I can't really place it anywhere there - which leads me to the conclusion it should be a blogpost.

@scoopex
Copy link
Contributor Author

scoopex commented Dec 3, 2024

Actually the comment that I made to the one item within the document applies to the whole document. I don't quite understand, why this is a documentation piece and not a blogpost. I tried to apply the diataxis framework to this document and I can't really place it anywhere there - which leads me to the conclusion it should be a blogpost.

Why does it make sense to describe the Hardware Landscape as part of the documentation?

  • The Hardware Landscape serves as a blueprint/demonstration environment that shows interested parties how such an almost real environment is actually configured
  • So that newcomers are also aware that this exists or that there is an infrastructure that can also be used in different contexts, it makes sense that the environment is directly visible or explorable as a turnkey solution
  • In the future, this page will also serve to describe the rules and usability for the Forum SCS standards in more detail (e.g. how users can access the environment).

In principle, however, it also makes sense to create at least a short blog article pointing out that the environment and its documentation exist.

@fkr fkr merged commit ae6d0f2 into main Dec 3, 2024
6 checks passed
@fkr fkr deleted the hardware-landscape branch December 3, 2024 13:27
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.

3 participants