docs November 2017

docs@lists.fedoraproject.org

11 participants
21 discussions

"Improve this Page" Corner Ribbon
by Brian Exelbierd 27 Nov '17

27 Nov '17

Hi All, Please test and comment on the "improve this page" corner ribbon on the rawhide docs version. It is live on docs.stg.fedoraproject.org and will hit production at some point. Should we do this for all active versions of our books? We can theoretically offer it to non-docs maintained content repos too. regards, bex

3 4

Doc sources not on Pagure
by Brian Exelbierd 27 Nov '17

27 Nov '17

Hi, I've been talking Mirek who works on the Defensive Coding Guide and he is interested in seeing it published with the Fedora Docs on the docs website. Today it doesn't have a publishing home. The source lives in a repo at gitlab.com and is in DocBook. Converting this to AsciiDoc should be possible. Are we ok with publishing from gitlab.com hosted source? Moving to Pagure presents some CI/CD challenges for the testing of the content. I think they may be open to a move long-term, but we need to get there first. The thinking is that we would pull their AsciiDoc source and build it ourselves. This is NOT taking built html from them. What do people think? regards, bex

3 3

xrefs and AsciiBinder
by Brian Exelbierd 27 Nov '17

27 Nov '17

By chance I had a conversation yesterday in person with pbokoc, pkovar and rkratky. We wound up discussing xrefs (because we are that kind of cool!). As you may know, xrefs allow you to link to a piece of content without having to know where it actually lives. In DocBook you link to the id of the section/etc. AsciiBinder does not support xrefs today. AsciiDoc has syntax for them, but the processing that AsciiBinder does to build the site precludes us from using it. I believe I can get us something like this working though. Is there an interest? = Xrefs in AsciiBinder A plugin will be written (I have a rough Proof Of Concept done) that overloads the AsciiDoc xref syntax. We would now be able to do the following: xref:title_with_underscores_case_insensitive[optional text to use for the link text - otherwise the title is used] This would link to the page that has that title. But what about collisions? If two pages have the same title, you will need to be more specific. Using the Dir entries from the _topic_map.yml you would specify: xref:dir/title_with_underscores_case_insensitive[optional text to use for the link text - otherwise the title is used] This may or may not work fully if you have a / (slash) in your title. If we want xrefs back, I am willing to sacrifice this :) are you? = Cross-repo linking As a bonus, we can probably get something like this to work: xref:content-set@dir/title_with_underscores[optional link text] The content-set level linking would only be available to books/content that is jointly published. The content-set is the same as the name of the repository. This means that you could link to the install-guide from the release-notes but you can't link to the council docs. The install-guide and release-notes are published in the same area of the site. Council docs is separate. What do you think? regards, bex

3 4

[Fedocal] Reminder meeting : Fedora Docs Weekly Meeting
by immanetize＠fedoraproject.org 26 Nov '17

26 Nov '17

Dear all, You are kindly invited to the meeting: Fedora Docs Weekly Meeting on 2017-11-27 from 14:00:00 to 15:00:00 UTC At fedora-meeting(a)irc.freenode.net The meeting will be about: An hour of docs folks talking about what they are working on and what they'd like to work on. More information available at: [https://fedoraproject.org/wiki/Docs_Project_meetings](https://fedoraproject… Source: https://apps.fedoraproject.org/calendar/meeting/371/

1 0

Should our doc repos email to docs@fp.o on new issues and PRs?
by Brian Exelbierd 21 Nov '17

21 Nov '17

TSSIA https://pagure.io/docs-fp-o/issue/32 regards, bex

1 0

Release Notes
by Brian Exelbierd 21 Nov '17

21 Nov '17

Hi All, We still have 7 Changes that need to be documented for the Release Notes. I am going to be updating the RPM soon, it'd be great to include these. Thanks, bex

1 0

Introducing myself
by Joakim Forøysund 21 Nov '17

21 Nov '17

Hi all! I am new to this mailing list and would like to introduce myself. I am an automation technician and technical institute engineer. I have been using various Linux distros on and off since 2005 when I first got introduced to Fedora. I've switched between Ubuntu, Debian, Mint and Fedora, but over time I have found that Fedora is the distro that suits me best and the one I actually enjoy quite a lot. For a few years a Macbook has been my goto-computer, but I've tried to keep up with what's happening in the Linux world. Now I want to contribute to the Fedora project since I've started using it on a regular basis again, simply because I think it's a brilliant system. In time I want to contribute in development and programming, but first I want to get to know Fedora even better by contributing to docs and translation. I have signed up for several of the mailing lists, including the join, docs and trans lists. I have registered on FAS, signed CLA and uploaded the SSH key. In Zanata I am approved for writing and I have logged in to Pagure. I have already translated some content in Zanata to get started. I have also joined several IRC channels where my nick is foroysund. I have to admit that it has been a bit overwhelming to get an overview of all the different sites and systems that are being used. I still struggle finding my way around, but I'll get a hold of it soon. I look forward to contributing and collaborating with you all. If anyone has any advice or heads up for me it will be highly appreciated. Also, I still have no access to any FAS groups (except Signed CLA Group and Signers of the Fedora Project Contributor Agreement), but I've applied to the Fedora Translators Group. I would like to hear from you if there are any other groups or forums I should join. Again, I am looking forward to contributing and collaborating with you all, and last but not least being part of the community. Sincerely, Joakim Forøysund

1 0

Mandatory Release notes for Changes
by Jan Kurik 21 Nov '17

21 Nov '17

For a long time we have an issue with readiness of Release notes for a release. To solve this issue me and @bex met and we came up with a proposal for a Changes Policy [2] addendum. As I would like to have people from different teams (Devel, QA, Doc, Trans, ...) to review this proposal and I do not want to have the discussion scatter over sever mailing lists I opened a FESCo ticket [1] describing the Release notes process we agreed on. If anyone is interested in this topic, please contribute to the ticket. [1] https://pagure.io/fesco/issue/1796 [2] https://fedoraproject.org/wiki/Changes/Policy Thanks, Jan -- Jan Kuřík Platform & Fedora Program Manager Red Hat Czech s.r.o., Purkynova 99/71, 612 45 Brno, Czech Republic

1 0

!! Publishing F27 docs tomorrow
by Brian Exelbierd 20 Nov '17

20 Nov '17

Hi all, I have staged, what I believe to be the final commits for F27 GA release. If we get more RN material done today, I can restage. The docs.stg.fedoraproject.org url is up with changes. (or should be within about 10 min of this email). Please test this. Tomorrow, I will be on a plane. About an hour before GA (GA is at 1500 UTC), we need to merge PR 1 from stg into prod. PR: https://pagure.io/fedora-docs/fedora-docs-web/pull-request/1 I should be on Telegram when not literally in the air. regards, bex PS: I have set this up as a PR in case it doesn't get done. I can click merge from my phone :)

2 2

Docs Site updates (open loops)
by Brian Exelbierd 20 Nov '17

20 Nov '17

Hi All, Updates: * CI is still in progress - I got sidelined last week and this week by conferences that restricted my large blocks of time work * Tables are broken for translations. The bug appears to be in `po4a`. I've written a patch and am having it tested by JB in French before pushing upstream. Upstream has the patch for review - they want more tests :P * Directory dances: F27 docs are being published at docs.fp.o/f27 ... There is a desire to have some durable links at docs.fp.o/current. To make this happen we need to enable canonical url support for asciibinder. i have a few ideas but no code yet. This will either be simple, or require a simple patch for variables to asciibinder. An open question is about whether it is ok to have canonical links on every page, not just those under /current. regards, bex

2 2

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

docs November 2017