You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@streampipes.apache.org by "ittuann (via GitHub)" <gi...@apache.org> on 2024/06/28 15:10:19 UTC
[D] feat: Add Go Client documentation website
GitHub user ittuann created a discussion: feat: Add Go Client documentation website
I noticed that the Go client currently under development does not yet have accompanying documentation or a website.
I therefore propose to use the Go-developed [Hugo](https://gohugo.io/) framework, combined with the [Docsy](https://www.docsy.dev/) theme to create a documentation site. Hugo is an efficient static site generator, and paired with Docsy, which is designed for technical documentation, it is well-suited for our project documentation needs.
For this purpose, I have quickly set up a demo site. If this proposal is approved, I would be willing to commit my current work to the project.
GitHub link: https://github.com/apache/streampipes/discussions/2973
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "dominikriemer (via GitHub)" <gi...@apache.org>.
GitHub user dominikriemer added a comment to the discussion: feat: Add Go Client documentation website
Hi @ittuann great that you are working on the documentation!
Appreciate your effort and I also support this proposal.
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9940922
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "ittuann (via GitHub)" <gi...@apache.org>.
GitHub user ittuann edited a comment on the discussion: feat: Add Go Client documentation website
> I really appreciate a proper documentation for the Go client, @ittuann
>
> Do you want to make the documentation part of our website or where should it be?
>
> In general, I would like the style to be a bit more in line with our StreamPipes color scheme (primary and accent color, etc.)
Based on the format of the Python Client docs website, I modeled the Go Client docs website! This is exactly why I chose the Hugo framework developed in Go.
Therefore, I want to integrate the documentation to be part of the main website, accessible from the main site's dropdown menu, just like the Python Client docs website.
For the color scheme, I configured it as `#39B54A` and `#1B1464` in turn with reference to the Python client.
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9935329
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "tenthe (via GitHub)" <gi...@apache.org>.
GitHub user tenthe added a comment to the discussion: feat: Add Go Client documentation website
Also +1 from my side. @ittuann thanks for the effort.
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9940902
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "bossenti (via GitHub)" <gi...@apache.org>.
GitHub user bossenti added a comment to the discussion: feat: Add Go Client documentation website
I really appreciate a proper documentation for the Go client, @ittuann
Do you want to make the documentation part of our website or where should it be?
In general, I would like the style to be a bit more in line with our StreamPipes color scheme (primary and accent color, etc.)
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9928891
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "ittuann (via GitHub)" <gi...@apache.org>.
GitHub user ittuann added a comment to the discussion: feat: Add Go Client documentation website
> I really appreciate a proper documentation for the Go client, @ittuann
>
> Do you want to make the documentation part of our website or where should it be?
>
> In general, I would like the style to be a bit more in line with our StreamPipes color scheme (primary and accent color, etc.)
Based on the format of the Python Client docs website, I modeled the Go Client docs website! This is exactly why I chose the Hugo framework developed in Go.
Therefore, I want to integrate the documentation to be part of the main website, accessible from the main site's dropdown menu, just like the Python Client docs website.
For the color scheme, I configured it with reference to the Python Client.
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9935329
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org
Re: [D] feat: Add Go Client documentation website
Posted by "bossenti (via GitHub)" <gi...@apache.org>.
GitHub user bossenti added a comment to the discussion: feat: Add Go Client documentation website
> Therefore, I want to integrate the documentation to be part of the main website, accessible from the main site's dropdown menu, just like the Python Client docs website.
Okay, great 👍🏼
Yep, this screenshot looks much better!
So approved from my side 🙂
How about the others?
GitHub link: https://github.com/apache/streampipes/discussions/2973#discussioncomment-9938332
----
This is an automatically sent email for dev@streampipes.apache.org.
To unsubscribe, please send an email to: dev-unsubscribe@streampipes.apache.org