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

move to official vala documentation docs.vala.dev #3

Open
lw64 opened this issue Oct 24, 2024 · 7 comments
Open

move to official vala documentation docs.vala.dev #3

lw64 opened this issue Oct 24, 2024 · 7 comments

Comments

@lw64
Copy link

lw64 commented Oct 24, 2024

I think this would be very nice to have in the upstream docs. It would of course need a bit of formatting changes and a review. Whats you opinion on this?

@phastmike
Copy link
Member

Hi @lw64 Sorry for late reply but professional and personal matters have have been keeping me away from contributions.

Not sure what you mean by upstream, the original document?

Fell free to contribute :)

@phastmike
Copy link
Member

Btw, here's the implementation of those patterns in Vala.
Stopped updating it some time ago but may still be, mostly, up to date:

https://github.com/phastmike/vala-design-patterns-for-humans

@naipotato
Copy link

Lorenz refers to Vala's documentation as "upstream": https://docs.vala.dev/

@lw64
Copy link
Author

lw64 commented Nov 15, 2024

Yes, I meant that :)

I think we could put these in a docs repo subfolder, and then use this sphinx feature to have them appear in the pages with some comments, explanations:

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-literalinclude

@phastmike
Copy link
Member

phastmike commented Nov 16, 2024

Hi @lw64 and @naipotato

Thanks for clarification :) For sure it would be nice. I'm not aware of the inner workings of the GNOME project guys and Vala developers and maintainers.

The original document has MIT license if not mistaken so I guess that with simple modifications it could be reused.
These concepts are not copyrighted :)
There's also the implementation repository that has code that could also be reused.

don't have time to put in this right now but if you, do or know whom, feel free to discuss/indicate :)

@lw64
Copy link
Author

lw64 commented Nov 17, 2024

there aren't really "inner workings", if we want to include it nobody stops anyone :)

thanks for informing about the license, we will declare the page as MIT of course (if you did significant changes/additions, then we can credit you too, also of course for the vala code samples).

don't worry about your time, there are enough other people happy to do the work (including me ;), I just wanted to communicate with you about it before.

Also when this will eventually be done, maybe you could add (you could merge a PR done by someone else ;) a banner that references to the new location, if you are ok with that.

@phastmike
Copy link
Member

Hi Lorenz :)

Thank you for the scope and willingness to help. Feel free to proceed as you see fit best.

My work on the document was mostly to adapt it to Vala. At the time (some years ago) there was a community around the translation of this document (content and programming language). The original author was also very open about it.

I'll leave the issue open for communication :)

BR

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

No branches or pull requests

3 participants