Re: help us launch a new, cool website for Twisted
Hello everyone, I kept working on pelican a bit: https://judgegregg.github.io/pelitwi/ (source: https://github.com/JudgeGregg/pelitwi) All pages should be available, along with some fake index files to reflect the current repository structure. I added a navbar with a link to the index page and some links to prev/next topic, as per the current rst doc (only for the first few pages so far). However, we're currently at a turning point (I think): - adding these links implies to add 3 custom attributes to each rst page (eg on the core/howto/index.rst file): :prev_page_slug: twisted-core :next_page_slug: the-vision-for-twisted :navbar_link: twisted-core These attributes are then used in custom Jinja filters during content generation. So, this would need to be done on every page in order to create a "linked chain of links". Is it a good thing to have, or do we have other plans for the trac doc ? Besides this, I'll try to add the static file management for examples files: via includes and static pelican file, as per my previous mail. And finally there are still the API links missing. Maybe turning these to regular links would be sufficient ? Thank you for your feedback :) -- Grégoire Juge
I haven't had much bandwidth for working on this, but I did at least want to say thank you for doing this, it's extremely helpful :-) -g
On Sep 12, 2021, at 9:56 AM, Grégoire JUGE <gregoire.juge@gmail.com> wrote:
Hello everyone,
I kept working on pelican a bit: https://judgegregg.github.io/pelitwi/ <https://judgegregg.github.io/pelitwi/> (source: https://github.com/JudgeGregg/pelitwi <https://github.com/JudgeGregg/pelitwi>)
All pages should be available, along with some fake index files to reflect the current repository structure. I added a navbar with a link to the index page and some links to prev/next topic, as per the current rst doc (only for the first few pages so far).
However, we're currently at a turning point (I think): - adding these links implies to add 3 custom attributes to each rst page (eg on the core/howto/index.rst file):
:prev_page_slug: twisted-core :next_page_slug: the-vision-for-twisted :navbar_link: twisted-core
These attributes are then used in custom Jinja filters during content generation.
So, this would need to be done on every page in order to create a "linked chain of links". Is it a good thing to have, or do we have other plans for the trac doc ?
Besides this, I'll try to add the static file management for examples files: via includes and static pelican file, as per my previous mail.
And finally there are still the API links missing. Maybe turning these to regular links would be sufficient ?
Thank you for your feedback :)
-- Grégoire Juge _______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/CAS4EHUZ434... Code of Conduct: https://twisted.org/conduct
Hi, I also haven't had much time for Twisted web page. I think that Pelican is nice, but it's an overkill forTwisted. We already have a lot of documentation and examples as part of our docs at https://docs.twistedmatrix.com/en/stable/ The Trac Wiki has a lot of old / obsolete info. So maybe it is better to just move the important part from Trac wiki to Twisted main documentation. And for Twisted start page, just have a simple single page GitHub Page I have started migrating the TracWiki to Github wiki. The GitHub Wiki import was done... bit GitHub Wiki doesn't support TracWiki format. So the pages need to be converted to MediaWiki or RST or Markdown A preview here: https://github.com/twisted/twisted/wiki/TwistedCommunity If anyone wants to have Pelican for Twisted web page, I am not -1. Is just that I will not have time to help. I did the quick Trac Wiki to GitHub Wiki migration as Plan B. Regards On Mon, 20 Sept 2021 at 00:46, Glyph <glyph@twistedmatrix.com> wrote:
I haven't had much bandwidth for working on this, but I did at least want to say thank you for doing this, it's extremely helpful :-)
-g
On Sep 12, 2021, at 9:56 AM, Grégoire JUGE <gregoire.juge@gmail.com> wrote:
Hello everyone,
I kept working on pelican a bit: https://judgegregg.github.io/pelitwi/ (source: https://github.com/JudgeGregg/pelitwi)
All pages should be available, along with some fake index files to reflect the current repository structure. I added a navbar with a link to the index page and some links to prev/next topic, as per the current rst doc (only for the first few pages so far).
However, we're currently at a turning point (I think): - adding these links implies to add 3 custom attributes to each rst page (eg on the core/howto/index.rst file):
:prev_page_slug: twisted-core :next_page_slug: the-vision-for-twisted :navbar_link: twisted-core
These attributes are then used in custom Jinja filters during content generation.
So, this would need to be done on every page in order to create a "linked chain of links". Is it a good thing to have, or do we have other plans for the trac doc ?
Besides this, I'll try to add the static file management for examples files: via includes and static pelican file, as per my previous mail.
And finally there are still the API links missing. Maybe turning these to regular links would be sufficient ?
Thank you for your feedback :)
-- Grégoire Juge _______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/CAS4EHUZ434... Code of Conduct: https://twisted.org/conduct
_______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/JOWNP3EP2JL... Code of Conduct: https://twisted.org/conduct
-- Adi Roiban
Hi all, Just a followup for my previous email. My intention with the previous email wasn't to discourage the Pelican migration. I like Pelican and I am using it for my business. If you think that you have a website ready for Twisted, and would like to see it live please send the PR at https://github.com/twisted/twisted.github.io ---------- I just wanted to say that I went with a Plan C, and moved the wiki to GitHub. To avoid confusion, I have disabled the GitHub Wiki for Twisted... but the repo is still there and can be enabled. ------------ The plan B is still active, and that is to keep the Trac Wiki (exactly) as it is but on a different VM. But I think that any option to replace the current Trac Wiki is on the table, including using pelican. Regards On Mon, 20 Sept 2021 at 01:07, Adi Roiban <adiroiban@gmail.com> wrote:
Hi,
I also haven't had much time for Twisted web page.
I think that Pelican is nice, but it's an overkill forTwisted.
We already have a lot of documentation and examples as part of our docs at https://docs.twistedmatrix.com/en/stable/
The Trac Wiki has a lot of old / obsolete info.
So maybe it is better to just move the important part from Trac wiki to Twisted main documentation.
And for Twisted start page, just have a simple single page GitHub Page
I have started migrating the TracWiki to Github wiki. The GitHub Wiki import was done... bit GitHub Wiki doesn't support TracWiki format. So the pages need to be converted to MediaWiki or RST or Markdown A preview here: https://github.com/twisted/twisted/wiki/TwistedCommunity
If anyone wants to have Pelican for Twisted web page, I am not -1. Is just that I will not have time to help.
I did the quick Trac Wiki to GitHub Wiki migration as Plan B.
Regards
On Mon, 20 Sept 2021 at 00:46, Glyph <glyph@twistedmatrix.com> wrote:
I haven't had much bandwidth for working on this, but I did at least want to say thank you for doing this, it's extremely helpful :-)
-g
On Sep 12, 2021, at 9:56 AM, Grégoire JUGE <gregoire.juge@gmail.com> wrote:
Hello everyone,
I kept working on pelican a bit: https://judgegregg.github.io/pelitwi/ (source: https://github.com/JudgeGregg/pelitwi)
All pages should be available, along with some fake index files to reflect the current repository structure. I added a navbar with a link to the index page and some links to prev/next topic, as per the current rst doc (only for the first few pages so far).
However, we're currently at a turning point (I think): - adding these links implies to add 3 custom attributes to each rst page (eg on the core/howto/index.rst file):
:prev_page_slug: twisted-core :next_page_slug: the-vision-for-twisted :navbar_link: twisted-core
These attributes are then used in custom Jinja filters during content generation.
So, this would need to be done on every page in order to create a "linked chain of links". Is it a good thing to have, or do we have other plans for the trac doc ?
Besides this, I'll try to add the static file management for examples files: via includes and static pelican file, as per my previous mail.
And finally there are still the API links missing. Maybe turning these to regular links would be sufficient ?
Thank you for your feedback :)
-- Grégoire Juge _______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/CAS4EHUZ434... Code of Conduct: https://twisted.org/conduct
_______________________________________________ Twisted mailing list -- twisted@python.org To unsubscribe send an email to twisted-leave@python.org https://mail.python.org/mailman3/lists/twisted.python.org/ Message archived at https://mail.python.org/archives/list/twisted@python.org/message/JOWNP3EP2JL... Code of Conduct: https://twisted.org/conduct
-- Adi Roiban
-- Adi Roiban
participants (3)
-
Adi Roiban
-
Glyph
-
Grégoire JUGE