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

doc: add graphic to vision page #20498

Merged
merged 1 commit into from
Mar 26, 2024
Merged

Conversation

miri64
Copy link
Member

@miri64 miri64 commented Mar 21, 2024

Contribution description

@maribu proposed on Matrix to add a graphic to the vision documentation page imported from the wiki. I had this graphic still flying around from a talk I did and I think it is fitting.

Testing procedure

Read the generated doc.

Issues/PRs references

Follow-up on #20491

@miri64 miri64 added the Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation label Mar 21, 2024
@github-actions github-actions bot added the Area: doc Area: Documentation label Mar 21, 2024
@miri64 miri64 added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Mar 21, 2024
Copy link
Member

@maribu maribu left a comment

Choose a reason for hiding this comment

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

I like this a lot. Thx! :)

We might want to not hit merge just yet and rather allow for others to have a look as well.

@waehlisch
Copy link
Member

thinking about to integrate this web page additionally into riot-os.org, some black lines would be shown on black background. can we find a way to maximize reuse of the content?

@miri64
Copy link
Member Author

miri64 commented Mar 21, 2024

thinking about to integrate this web page additionally into riot-os.org, some black lines would be shown on black background. can we find a way to maximize reuse of the content?

Given that we need to restructure the website anyways, if we want to integrate this Markdown into the website---currently the vision part there is a 1/3 page card type paragraph, this text would need something larger: couldn't we just use a white background for the vision section on the website? Would also symbolize a brighter future ;-).

@waehlisch
Copy link
Member

couldn't we just use a white background for the vision section on the website?

right, the body part of the text could be in white bg color

then consider the comment as a reminder that we should reuse structured data as much as possible ;).

@miri64
Copy link
Member Author

miri64 commented Mar 21, 2024

then consider the comment as a reminder that we should reuse structured data as much as possible ;).

I can add classes so that the style may be overwritten with external CSS. Have to think however, how to integrate this in the doxygen.

@miri64
Copy link
Member Author

miri64 commented Mar 21, 2024

I added some minimal CSS and classes. However, how to change that externally (without doing a sed on the SVG) is anyone's guess. Most current browsers neither seem to support importing external CSS for imported SVGs or using the HTML's CSS for imported SVGs. :-/

@miri64
Copy link
Member Author

miri64 commented Mar 21, 2024

Most current browsers neither seem to support importing external CSS for imported SVGs or using the HTML's CSS for imported SVGs. :-/

(And Doxygen's usage of XHTML doesn't make the situation any better)

@riot-ci
Copy link

riot-ci commented Mar 21, 2024

Murdock results

✔️ PASSED

0dc04f6 doc: add graphic to vision page

Success Failures Total Runtime
1 0 1 11s

Artifacts

@mguetschow
Copy link
Contributor

Quoting @chrysn from matrix discussion:

Maybe even throw in a Zephyr and/or a FreeRTOS in as well? (it's 5 RIOTs, we'd still have 3/5 and thus the absolute majority in the embedded space)

I'd second this to emphasize on IoT interoperability, but it might need some highlighting/explanation in the text, too.

@miri64
Copy link
Member Author

miri64 commented Mar 22, 2024

Quoting @chrysn from matrix discussion:

Maybe even throw in a Zephyr and/or a FreeRTOS in as well? (it's 5 RIOTs, we'd still have 3/5 and thus the absolute majority in the embedded space)

I'd second this to emphasize on IoT interoperability, but it might need some highlighting/explanation in the text, too.

I steered away from this, mainly because using foreign logos might raise some trademark issues (at least the Zephyr logo is a registered trademark, did not look up FreeRTOS). For the android logo, it does not seem to be the official one (see here, for Tux we might need to add a Copyright notice, if not already provided (will have a look).

@maribu
Copy link
Member

maribu commented Mar 22, 2024

Maybe it would even underline the intended message better to not pick zephyr/FreeRTOS/other concrete OS, but rather add some generic "other OS using standard internet protocols" node.

@miri64
Copy link
Member Author

miri64 commented Mar 22, 2024

Maybe it would even underline the intended message better to not pick zephyr/FreeRTOS/other concrete OS, but rather add some generic "other OS using standard internet protocols" node.

If you provide me with a design for that: Can do! 😁

@miri64 miri64 force-pushed the doc/enh/vision-graphic branch 2 times, most recently from 7103637 to c4b9c61 Compare March 22, 2024 13:07
@miri64
Copy link
Member Author

miri64 commented Mar 22, 2024

In the act of attributing the foreign logos correctly, I restructured the whole graphic to be more structural (any clipart is now its own defined path which then is only <use>'d in the graphic) and used only classes for styling. A “dark background” version of the graphic can be rendered by changing the stroke colors in #vision-division-line and .vision-house-line to white and the fill color for .vision-text to white. Just while writing this, I noticed that Tux might disappear with black background. Will provide a fixup for that!

@miri64
Copy link
Member Author

miri64 commented Mar 22, 2024

Done, there is now a thin white border around tux.

@kfessel kfessel added this pull request to the merge queue Mar 26, 2024
Merged via the queue into RIOT-OS:master with commit 20decc9 Mar 26, 2024
25 checks passed
@miri64 miri64 deleted the doc/enh/vision-graphic branch March 27, 2024 09:26
@MrKevinWeiss MrKevinWeiss added this to the Release 2024.04 milestone Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants