Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

community.html: update vision link #124

Merged
merged 1 commit into from
Mar 27, 2024

Conversation

maribu
Copy link
Member

@maribu maribu commented Mar 21, 2024

Now that the vision is in the official home of doc, let's update the links.

Now that the vision is in the official home of doc, let's update the
links.
Copy link

🚀 PR preview deployed to https://RIOT-OS-riot-os-org-preview-124.surge.sh

@waehlisch
Copy link
Member

waehlisch commented Mar 21, 2024

i think we can improve the integratoin. as the vision is now a md file, we can directly integrate the file into the website, e.g., by dynamically fetching from the git repo.

@chrysn
Copy link
Member

chrysn commented Mar 21, 2024

An inclusion can be a good next step, although given the current drive to collect documentation centrally from the previously spread-out sources, that should go with some clear indication on where that "sits". (Like, a "view this as part of the documentation, or edit on GitHub" style link).

At any rate, this is a good fix.

@maribu
Copy link
Member Author

maribu commented Mar 21, 2024

I wonder if from a technical point of view it would make more sense to just move the markdown into this repo, then. Otherwise we would have to make sure that the website stays in sync with main repository.

Note that moving the markdown for the vision in this repo would have to be carefully synchronized with RIOT-OS/RIOT#20498.

Maybe it would make sense to update the vision link as an intermediate step to doc.riot-os.org? IMO the RIOT wiki looks like it is on life-support and has been for quite some time, which is not an ideal first impression. Hence, I'd rather move the attention towards the Doxygen doc and away from the Wiki :)

@miri64
Copy link
Member

miri64 commented Mar 21, 2024

Otherwise we would have to make sure that the website stays in sync with main repository.

That is already the case, AFAIK, because of the CPU/boards lists.

@waehlisch
Copy link
Member

Otherwise we would have to make sure that the website stays in sync with main repository.

That is already the case, AFAIK, because of the CPU/boards lists.

i don't understand this discussion. the content is automatically synchronized. and yes, we need to ensure that this tool chain work, but this is also true for the website infrastructure (or any other infrastructure) in general. the only important thing: automatic sync.

@miri64
Copy link
Member

miri64 commented Mar 21, 2024

i don't understand this discussion.

From my side, there is no discussion. I just wanted to clarify, that there is already a sync.

@miri64
Copy link
Member

miri64 commented Mar 22, 2024

So, shall we update the link for now and then update the page as suggested by @waehlisch in a follow-up?

@maribu
Copy link
Member Author

maribu commented Mar 27, 2024

Given that the vision on Doxygen has already been diverged from the one in the Wiki, how about updating this? I would also like to remove the copy from the Wiki once the links there are dropped.

Copy link
Member

@miri64 miri64 left a comment

Choose a reason for hiding this comment

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

ACK. If I have a bored hour or two in the coming time, I can look into the page re-design @waehlisch was asking for. I imagine keeping that card, but linking to another section on community.html that includes the vision.md from _RIOT/doc/doxygen/src. I will open an issue as a reminder.

@miri64
Copy link
Member

miri64 commented Mar 27, 2024

See #126

@miri64 miri64 merged commit be5b390 into RIOT-OS:master Mar 27, 2024
1 check passed
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants