Syngrafias - AsciiDocs Collaboration Tool for Fedora Documentation Maintainers, Available for testing
Hi,
We'd like to announce the public testing of Syngrafias, an Asciidoctor collaboration tool - a service for Fedora documentation maintainers aiming to provide an environment where they can collaborate by sharing their workspace among multiple contributors with active synchronization of edits at every end and live preview of the Asciidoctor files.
The preview version for public testing is now available here: http://35.231.107.163/
Please note that as it has been deployed on a low-tier Google Cloud instance, the first load might take a while.
Syngrafias leverages WebSockets backend to significantly improve upon the collaboration experience among multiple documentation writers and ensures an ultralight implementation of the workspace server. (~2MB above Python runtime)
It also includes the following features -
- Live Asciidoc editing and preview - Workspace identity can be shared among multiple people to collaborate in real time - Documents can be exported locally and imported in different workspaces - Unintrusive and focussed editing with cells inside a document
We would love to hear your feedback. Please keep in mind that this is a testing deployment and is currently running on an underpowered cloud instance. We are proposing it as a candidate GSoC project for it to be deployed, maintained and integrated in the Fedora Infrastructure this summer. Also the deployment goes offline on 8th January so be sure to check it out soon.
Feel free to provide ideas or bug reports at https://github.com/t0xic0der/syngrafias or simply send an email reply to this thread with all kinds of feedback and suggestions.
--- Nasir Hussain
Hello,
I tried but had a few issues.
1. why do we have to download content from external domains? It is an issue for privacy and for security. I see some content from: fonts.googleapis.com,fonts.gstatic.com and cdn.jsdelivr.net.
As this is an open-source project, you probably want to make sure everything you deliver is using a compatible license and audited content.
2. I tried to load an adoc file, but it failed. The modal says the imported file have to be in the "Syngrafias Workspace Document format", but how do we do this?
3. if you add something in the URL http://35.231.107.163/freshfishes/, the look and feel is not the same.
4. what is a workspace? how long does it last? how do I share it?
5. what is the workflow with the current fedora documentation system? I can't understand how contributors can use it with what we have. Could you provide some stories as examples?
Have a nice day,
Le 29/12/2020 à 12:38, Nasir Hussain a écrit :
Hi,
We'd like to announce the public testing of Syngrafias, an Asciidoctor collaboration tool - a service for Fedora documentation maintainers aiming to provide an environment where they can collaborate by sharing their workspace among multiple contributors with active synchronization of edits at every end and live preview of the Asciidoctor files.
The preview version for public testing is now available here: http://35.231.107.163/ http://35.231.107.163/
Please note that as it has been deployed on a low-tier Google Cloud instance, the first load might take a while.
Syngrafias leverages WebSockets backend to significantly improve upon the collaboration experience among multiple documentation writers and ensures an ultralight implementation of the workspace server. (~2MB above Python runtime)
It also includes the following features -
- Live Asciidoc editing and preview
- Workspace identity can be shared among multiple people to
collaborate in real time
- Documents can be exported locally and imported in different workspaces
- Unintrusive and focussed editing with cells inside a document
We would love to hear your feedback. Please keep in mind that this is a testing deployment and is currently running on an underpowered cloud instance. We are proposing it as a candidate GSoC project for it to be deployed, maintained and integrated in the Fedora Infrastructure this summer. Also the deployment goes offline on 8th January so be sure to check it out soon.
Feel free to provide ideas or bug reports at https://github.com/t0xic0der/syngrafias https://github.com/t0xic0der/syngrafias or simply send an email reply to this thread with all kinds of feedback and suggestions.
Nasir Hussain
docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org
Hello,
We addressed point #1 and #3 with some more quality-of-life changes via the most recent pull request which you can find here https://github.com/t0xic0der/syngrafias/pull/90.
For loading ".adoc" files, you need to switch over to the Unity Mode (ADOC) from the menubar. We missed out on informing about it, my bad :)
The workspace lasts as long as the time for which at least one person is connected to the workspace. Every change is kept in DOM so any refresh attempt or moving away can potentially make you lose your progress and that is why we recommend frequent saves.
The current workflow that the current contributors to Fedora Documentation follow is by first forking the repo, cloning stuff locally, making changes and then building to see the preview. We understand that the continual cycles of building and previewing can be rather inconvenient and hence we provide a live preview option to address it. In order to review documentation changes, a reviewer does not need to clone the changes locally when all they can do is simply share a workspace identity so that the changes can be viewed in real time and even the new ones can be suggested, or well added to the document right away.
Once done with all the changes, simply download a copy of the document and commit it to the fork and make a PR. We are planning on Noggin as well as Pagure integration as a scope of the GSOC participation so that the version control for the documentation projects can also be streamlined.
Thank you for taking your time out to review the public preview and suggesting the changes. Wish you a very happy 2021! :D
Regards, Akashdeep Dhar t0xic0der
On Wed, Dec 30, 2020 at 4:38 PM Jean-Baptiste jean-baptiste@holcroft.fr wrote:
Hello,
I tried but had a few issues.
- why do we have to download content from external domains? It is an
issue for privacy and for security. I see some content from: fonts.googleapis.com,fonts.gstatic.com and cdn.jsdelivr.net.
As this is an open-source project, you probably want to make sure everything you deliver is using a compatible license and audited content.
- I tried to load an adoc file, but it failed. The modal says the
imported file have to be in the "Syngrafias Workspace Document format", but how do we do this?
- if you add something in the URL http://35.231.107.163/freshfishes/,
the look and feel is not the same.
what is a workspace? how long does it last? how do I share it?
what is the workflow with the current fedora documentation system? I
can't understand how contributors can use it with what we have. Could you provide some stories as examples?
Have a nice day,
Le 29/12/2020 à 12:38, Nasir Hussain a écrit :
Hi,
We'd like to announce the public testing of Syngrafias, an Asciidoctor collaboration tool - a service for Fedora documentation maintainers aiming to provide an environment where they can collaborate by sharing their workspace among multiple contributors with active synchronization of edits at every end and live preview of the Asciidoctor files.
The preview version for public testing is now available here: http://35.231.107.163/ http://35.231.107.163/
Please note that as it has been deployed on a low-tier Google Cloud instance, the first load might take a while.
Syngrafias leverages WebSockets backend to significantly improve upon the collaboration experience among multiple documentation writers and ensures an ultralight implementation of the workspace server. (~2MB above Python runtime)
It also includes the following features -
- Live Asciidoc editing and preview
- Workspace identity can be shared among multiple people to
collaborate in real time
- Documents can be exported locally and imported in different workspaces
- Unintrusive and focussed editing with cells inside a document
We would love to hear your feedback. Please keep in mind that this is a testing deployment and is currently running on an underpowered cloud instance. We are proposing it as a candidate GSoC project for it to be deployed, maintained and integrated in the Fedora Infrastructure this summer. Also the deployment goes offline on 8th January so be sure to check it out soon.
Feel free to provide ideas or bug reports at https://github.com/t0xic0der/syngrafias https://github.com/t0xic0der/syngrafias or simply send an email reply to this thread with all kinds of feedback and suggestions.
Nasir Hussain
docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org Fedora Code of Conduct:
https://docs.fedoraproject.org/en-US/project/code-of-conduct/
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives:
https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org _______________________________________________ docs mailing list -- docs@lists.fedoraproject.org To unsubscribe send an email to docs-leave@lists.fedoraproject.org Fedora Code of Conduct: https://docs.fedoraproject.org/en-US/project/code-of-conduct/ List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org
-
Akashdeep Dhar -
Jean-Baptiste -
Nasir Hussain