Hi docs people!
I'm working on migrating the Workstation Working Group from the wiki to docs.fedoraproject.org.
Our docs project is located at https://pagure.io/fedora-workstation/workstation-docs . Could you add it to the website, please?!
Thanks!
Allan
On Fri, Sep 24, 2021 at 4:47 AM Allan Day aday@redhat.com wrote:
I'm working on migrating the Workstation Working Group from the wiki to docs.fedoraproject.org.
Our docs project is located at https://pagure.io/fedora-workstation/workstation-docs . Could you add it to the website, please?!
pbokoc beat me to it this morning. (And it was very clever of git to figure out that I was trying to push a change that was already made.) I will point out that your docs have "main" in the URL (e.g. https://docs.fedoraproject.org/en-US/workstation-working-group/main/ ) because Antora has "master" hardcoded. We found this out the hard way with the Council docs. So if you don't want that, you'll need to set `version` back to `master` in line 9 of your `antora.yml` file. If you're fine with that, then leave it as-is.
Message to Ben and working group Yes your standard is asciidoc, but for collaboration, I proceeded to use libreoffice with the track changes and Comments options.I have vetted, corrected grammer, added punctuation, reoved run-on sentences, and also revised some old stuff left over from Fedora 21. So, I have a tract changes mark up of the install guide. If someone collaborates with me to review the changes, it will not be a difficult job topast the output into asciidoc format I feel that collaaboration is a team effort, to review changes, so as to produce a good pdf output (LibreOffice does produce pdf output, if requested, It also, for those not in the know, produces output for docx odt, and other formats.
I have used asciidoc and just find that it is acceptable, because the maintenance is in ascii, but it is not convenient for tracking changes and collaboration.
I have reviewed about 100 pages of output. With two one hour settings, (approving, rejecting markups), a good start will be possible for producing the Fedora 35 install guide.
Regards Leslie Leslie Satenstein Montréal Québec, Canada
On Friday, September 24, 2021, 02:57:17 p.m. GMT-4, Ben Cotton bcotton@redhat.com wrote:
On Fri, Sep 24, 2021 at 4:47 AM Allan Day aday@redhat.com wrote:
I'm working on migrating the Workstation Working Group from the wiki to docs.fedoraproject.org.
Our docs project is located at https://pagure.io/fedora-workstation/workstation-docs . Could you add it to the website, please?!
pbokoc beat me to it this morning. (And it was very clever of git to figure out that I was trying to push a change that was already made.) I will point out that your docs have "main" in the URL (e.g. https://docs.fedoraproject.org/en-US/workstation-working-group/main/ ) because Antora has "master" hardcoded. We found this out the hard way with the Council docs. So if you don't want that, you'll need to set `version` back to `master` in line 9 of your `antora.yml` file. If you're fine with that, then leave it as-is.
On Fri, Sep 24, 2021 at 10:08:58PM +0000, Leslie S Satenstein wrote:
I have used asciidoc and just find that it is acceptable, because the maintenance is in ascii, but it is not convenient for tracking changes and collaboration.
Hey Leslie! I definitely appreciate the work you're putting into this. The workflow we're using with git and pull requests actually has a lot of functionality for tracking changes and collaboration, even though it's different from what you're used to.
You can see some examples of this in, for example, the Quick Docs repository. Like this one:
https://pagure.io/fedora-docs/quick-docs/pull-request/357
(Click on "Files changed" to see inline commentary.)
On Fri, Sep 24, 2021 at 10:08:58PM +0000, Leslie S Satenstein wrote:
I have used asciidoc and just find that it is acceptable, because the maintenance is in ascii, but it is not convenient for tracking changes
and
collaboration.
Thanks for volunteering to help with the documentation Leslie! Since you are working on the installation guide, you may find the examples on the page linked below insightful.
https://pagure.io/fedora-docs/install-guide/pull-requests?status=False
Each "Pull Request" listed on the above linked page tracks exactly who made exactly what change and when (browse the "Files Changed" tab for each PR to see exactly what was changed). There is a bit of a learning curve to using git if you aren't already familiar with it. But it is extremely powerful in terms of its ability to track changes (they can also be undone and "cherry picked" and there is support for merging conflicting changes by different authors but you don't need to worry about any of that to get started).
I would suggest starting small just to get things figured out. Try submitting a pull request to correct a small grammar mistake or typo first just to get the hang of how things work. Your submission should show up on the "Pull Requests" tab here: https://pagure.io/fedora-docs/install-guide
Once accepted ("merged"), the record of your change will be archived under the "XX Merged" link on the pull requests page.
Thanks for contributing!
Ben Cotton bcotton@redhat.com wrote: ...
I will point out that your docs have "main" in the URL (e.g. https://docs.fedoraproject.org/en-US/workstation-working-group/main/ ) because Antora has "master" hardcoded. We found this out the hard way with the Council docs. So if you don't want that, you'll need to set `version` back to `master` in line 9 of your `antora.yml` file. If you're fine with that, then leave it as-is.
Is there a ticket anywhere, tracking this issue? I think I'm probably going to have to change the default branch name to master, but I'd like to switch it back to main as soon as it's possible to do so.
Thanks,
Allan
On Thu, Oct 7, 2021 at 6:33 AM Allan Day aday@redhat.com wrote:
Is there a ticket anywhere, tracking this issue? I think I'm probably going to have to change the default branch name to master, but I'd like to switch it back to main as soon as it's possible to do so.
Looks like it's been fixed upstream: https://gitlab.com/antora/antora/-/issues/669
So I guess now it's up to us (asamalik?) to update our tooling.
The fix is only available on antora 3.0, which is still in alpha. https://docs.antora.org/antora/3.0/whats-new/#more-new-documentation
If we're not in a hurry, I'm more in favour of waiting for a stable version.
On 2021-10-07 14:49, Ben Cotton wrote:
On Thu, Oct 7, 2021 at 6:33 AM Allan Day aday@redhat.com wrote:
Is there a ticket anywhere, tracking this issue? I think I'm probably going to have to change the default branch name to master, but I'd like to switch it back to main as soon as it's possible to do so.
Looks like it's been fixed upstream: https://gitlab.com/antora/antora/-/issues/669
So I guess now it's up to us (asamalik?) to update our tooling.
Hi Alan, the docs have been added. They are now listed among the links in the Engineering Teams section on the frontpage, and at this link: https://docs.fedoraproject.org/en-US/workstation-working-group/main/
In turn, could you please go to the repo settings and add the group "fedora-docs" with admin privileges? It's just in case we need to change something in the settings in the future.
Cheers, Petr
On Fri, Sep 24, 2021 at 8:47 AM Allan Day aday@redhat.com wrote:
Hi docs people!
I'm working on migrating the Workstation Working Group from the wiki to docs.fedoraproject.org.
Our docs project is located at https://pagure.io/fedora-workstation/workstation-docs . Could you add it to the website, please?!
Thanks!
Allan _______________________________________________ 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 Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure
Petr Bokoc pbokoc@redhat.com wrote: ...
Hi Alan, the docs have been added. They are now listed among the links in the Engineering Teams section on the frontpage, and at this link: https://docs.fedoraproject.org/en-US/workstation-working-group/main/
Thanks!
In turn, could you please go to the repo settings and add the group "fedora-docs" with admin privileges? It's just in case we need to change something in the settings in the future.
Done.
Allan
Good morning AllanI am aware of your template, but it is not suitable to use for collaboration before transforming some *.odt files to the format specified in the template.I worked in a publishing house, and our method of producing good documentation was to use the "track changes" features of graphical word processors, processors such as LibreOffice.
Do I understand it correctly, that your role is to amass the documentation from the previous version, and just build the next version, or does it includeresponsibility for vetting the documentation and correcting same to have good grammar, context correctness?
Am I wrong in that a working document in LibreOffice *.odt that includes corrected grammar, and updates from the Fedora 21 stuff within to Fedora 35, prior to creating the templates, is not authoring role for content? I have a LibreOffice "*.odt" file with track changes markup. A collaborator would review my changes one by one, and would accept, refuse, or replace with a better markup. He would send that doc back to me, and I would review his changes and send it back to him. At that point, we would have a good clean document to convert to your template format. As I see it, a most sloppy, last minute, document I have read is the Fedora 34 one, with many inaccuracies.
What do you suggest to me. Am I able to put my doc into a tar file and email it to you. LibreOffice is the official office documentation tool for Fedora Workstation. I have been a Fedora user since before "Fedora became Fedora core", beginning at time of founding RHat. I just did the vetting as a way to give back for my 15 years of using Fedora.
Regards Leslie Leslie Satenstein Montréal Québec, Canada
On Friday, September 24, 2021, 04:47:33 a.m. EDT, Allan Day aday@redhat.com wrote:
Hi docs people!
I'm working on migrating the Workstation Working Group from the wiki to docs.fedoraproject.org.
Our docs project is located at https://pagure.io/fedora-workstation/workstation-docs . Could you add it to the website, please?!
Thanks!
Allan _______________________________________________ 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 Do not reply to spam on the list, report it: https://pagure.io/fedora-infrastructure