Antora "watch mode" (and Vim hack)
by Ankur Sinha
Hi,
I was looking at whether Antora could automatically generate pages when
the source change so that previewing while modifying docs would be
somewhat easier. (One does not need to re-run ./preview.sh, but
./build.sh must be re-run after each change.)
I'd filed a ticket upstream and was directed to this discussion:
https://gitlab.com/antora/antora/issues/329
It seems to be a WIP, and for the moment there's a way to do this. It
uses a gulpfile(?) however, and I don't know enough to figure out how to
make this work with our workflow. Would someone know?
------
Also, as a hack in the meantime, if you use vim, you can re-run the
./build.sh script each time a buffer is saved using "BufWritePost". So
something like this in your .vimrc would work:
augroup fedora_docs
autocmd!
autocmd BufWritePost *adoc !./build.sh
augroup END
There's a caveat, though---you must start vim in the project root where
./build.sh resides. I'm sure there's a way to detect the project root
and find ./build.sh and put the output into the quickfix list etc, but
I've not gotten down to writing a full plugin yet. :)
Add fugitive to the mix etc., and you don't need to exit vim while
editing docs at all:
https://github.com/tpope/vim-fugitive
Please feel free to improve on this and share them with everyone. Your
friends in the vim documentation are:
: help augroup
: help autocmd
: help BufWritePost
My rather messy vimrc is here for reference:
https://github.com/sanjayankur31/vimfiles/blob/master/vimrc
--
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) | https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London
3 years, 8 months
[Fedocal] Reminder meeting : Docs Writing Hour
by pbokoc@fedoraproject.org
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2019-08-28 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9360/
3 years, 9 months
Self-Introduction
by mowestusa
Hello Docs team,I've been a Linux user since 2004 but had a 6-7 year gap before picking up Linux again 2 years ago. To assist my son who was running a 1st generation RaspberryPI B with Raspbian, I resharpened my Linux skills by installing mostly Ubuntu based distros on old hardware. Before my hiatus away from Linux, Fedora was my daily driver, and a few weeks ago I came back to Fedora installing it on my latest "new to me" Dell Optiplex 390. Currently, I'm having fun running Fedora 30 Server with Fluxbox on top for my Window Manager / Desktop of choice. I enjoy the CLI and learning new commands to manage my Linux boxes from the CLI.
What I love about Linux more than anything is the community. I don't have a lot of money, hence the reason why I'm running Linux on 7-10 year old computers with 4gb of RAM and running lightweight Window Mangers like Fluxbox, but I would like to give back to the Linux community that has given so much to me. I've been involved in providing help to users in the Bodhi Linux forum and Discord, and I participate in the Virtual LUG community known as "Big Daddy Linux" on Youtube and their Discourse forum.
I believe that my profession as a pastor who takes challenging ideas and presents those ideas through writing, preaching, and teaching has provided me with a background that I hope will be helpful in creating technical documentation for Fedora users. I love breaking down complex ideas and presenting them in different ways for the benefit of others. I also enjoy hearing feedback, and using it to adjust my presentation of information for their benefit.
Although I have only recently come back to Fedora, I decided to join the docs team for the following reasons. I remember the Fedora community as being welcoming and willing to help new users. I noticed that Fedora Docs is using ASCIIDOC which is a technology I have used in the past and enjoyed. Fedora Docs had a process to bring new contributors into the project. Although I have wanted to participate in documentation efforts in other Linux Communities, I did not find a series to steps to follow to get involved. Fedora offered those steps so here I am with my "Self-Introduction" email.
I live in the US Eastern Time Zone. I would enjoy helping out with tutorials and documentation that helps the new Fedora user grow from a beginner to an advanced user. Hopefully, you can find a place for me to help out.
Below is my gpg public key, this was the most complicated part of joining the Fedora community but I think I did it right.
pub rsa2048 2019-08-21 [SC] [expires: 2020-08-20]
9C8B 56E1 63AB 8A0D 19E8 DF0E 870D BDB2 9851 0C04
uid [ultimate] Stephen Daley (FedoraKeyPair) <mowestusa(a)yahoo.com>
sub rsa2048 2019-08-21 [E] [expires: 2020-08-20]
---------------------------- | Steve | | mowestusa(a)yahoo.com | ----------------------------
3 years, 9 months
[Fedocal] Reminder meeting : Docs Writing Hour
by pbokoc@fedoraproject.org
Dear all,
You are kindly invited to the meeting:
Docs Writing Hour on 2019-08-21 from 10:00:00 to 11:00:00 US/Eastern
The meeting will be about:
Join members of the docs team in #fedora-docs for writing time. This is a great time to focus on writing and talk about challenges and blockers related to producing content.
There is no formal schedule for this meeting. Attendees should show up and use this as a way to block writing time into their week.
Source: https://apps.fedoraproject.org/calendar/meeting/9360/
3 years, 9 months
[Bug 1284490] Link in Fedora 23 documentation refers to Fedora 21
documentation
by bugzilla@redhat.com
https://bugzilla.redhat.com/show_bug.cgi?id=1284490
Petr Bokoc <pbokoc(a)redhat.com> changed:
What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |CLOSED
Resolution|--- |EOL
Last Closed| |2019-08-15 13:50:42
--- Comment #1 from Petr Bokoc <pbokoc(a)redhat.com> ---
Unfortunately I didn't see this bug when it was opened, and at this point
republishing F23 docs would be way too much effort to fix a single broken link,
so regrettably I have to close this.
--
You are receiving this mail because:
You are on the CC list for the bug.
3 years, 9 months