F21 Beats Status & Docs Schedule
by Pete Travis
First, the schedule. You can read it in full at
https://fedorapeople.org/groups/schedule/f-21/f-21-docs-tasks.html, but
the TL;DR version is that this is the week to sprint and cover anything
remaining. Next week is porting from the wiki into docbook/git and
dynamically out for translation.
The system wide changes have had fairly good coverage, with only a few
unwritten or requiring updates.
* Server role deployment:
This is covered mostly as suggested in the Change page, but I think it
could use elaboration. The role deployment functionality is doing *a
lot*; package installation, firewall configuration, initial
configuration management, and probably more.
* GNOME
Gnome is covered for the 3.12 release, but we're expecting to ship
3.14. The upstream 3.14 notes are under draft? at
https://wiki.gnome.org/ThreePointThirteen/ReleaseNotes with discussion
on desktop-devel-list(a)gnome.org
* Mono
Beat unclaimed and unwritten.
* SCL
status unclear from Change page and tracking bug, package not present?
* Products
The Product specific beats also need work. Some Cockpit
screenshots, links to docs and general overview of the Server product
will improve the already documented Changes. Much of the *substance* of
the Workstation release will be covered in the GNOME beat, but I haven't
written the overview for it yet (still claiming it, though :P ). The
Cloud product(s) need the most coverage; while the number of Changes are
low, there are multiple cloud images being generated and the working
group generated a massive volume of trac tickets in preparation for the
release that we should review.
The Self Contained changes become more important as we approach the Beta
release, and *all* proposed changes must be completed by 14 October. To
contrast that, the porting of wiki content is scheduled to begin on 2
October. As of now, the Self Contained Changes are largely
undocumented. While contributions in this are welcome, I propose that
in the short term we focus on completing the System Wide changes and
migrating to git. This will give translators more time to work on this
content and allow maintainers to bring their change pages up to date.
To make it easier to keep organized, it might be best to work on copy
for the self contained changes directly in Git.
I'll follow up with a mail about the migration next week. For now,
thanks for your efforts! Please remember to coordinate with your fellow
contributors by replying here or visiting #fedora-docs.
--
-- Pete Travis
- Fedora Docs Project Leader
- 'randomuser' on freenode
- immanetize(a)fedoraproject.org
9 years, 7 months
Fedora Docs Meeting Minutes 22SEP2014
by Pete Travis
====================================================================================================
#fedora-meeting: Docs Project Meeting - Agenda: https://fedoraproject.org/wiki/Docs_Project_meetings
====================================================================================================
Meeting started by pbokoc at 14:08:29 UTC. The full logs are available
at
http://meetbot.fedoraproject.org/fedora-meeting/2014-09-22/fedora_docs.20...
.
Meeting summary
---------------
* Roll Call (pbokoc, 14:08:52)
* Follow up on last week's action items (pbokoc, 14:10:48)
* ACTION: randomuser to send mail to list regarding beats status
(pbokoc, 14:12:05)
* LINK:
https://lists.stg.fedoraproject.org/archives/list/websites@lists.fedorapr...
(pbokoc, 14:14:20)
* New Writers (pbokoc, 14:16:12)
* Release Notes / Beats (pbokoc, 14:20:54)
* LINK:
https://fedorapeople.org/groups/schedule/f-21/f-21-docs-tasks.html
(pbokoc, 14:21:02)
* We'd like to have beats written by F21 beta release - 2014-10-28; if
you have time, grab an unclaimed change and write it (pbokoc,
14:28:07)
* LINK: http://red.ht/1sPgI5t (pbokoc, 14:28:28)
* ACTION: randomuser to review changes this week for unclaimed ones
(randomuser, 14:28:41)
* Guide Status (randomuser, 14:34:36)
* task list for the IG: http://red.ht/1s2GmSK - if you want to help,
find something in there and ping pbokoc if you need any
details/direction (pbokoc, 14:35:40)
* ACTION: randomuser to create repo for firewall-guide (randomuser,
14:39:18)
* looking over guides for things that need to be updated for F21 is
helpful (randomuser, 14:42:59)
* help for the install guide rewrite would be appreciated
(randomuser, 14:49:28)
* Open Floor Discussion (randomuser, 14:58:01)
Meeting ended at 15:01:36 UTC.
Action Items
------------
* randomuser to send mail to list regarding beats status
* randomuser to review changes this week for unclaimed ones
* randomuser to create repo for firewall-guide
Action Items, by person
-----------------------
* randomuser
* randomuser to send mail to list regarding beats status
* randomuser to review changes this week for unclaimed ones
* randomuser to create repo for firewall-guide
* **UNASSIGNED**
* (none)
People Present (lines said)
---------------------------
* pbokoc (68)
* randomuser (38)
* yruseva (18)
* RogerBTX40 (15)
* bara_ (7)
* jjmcd (7)
* zodbot (5)
* RogerBTX (3)
* rkratky (1)
* pkovar (1)
* randomus` (0)
Generated by `MeetBot`_ 0.1.4
.. _`MeetBot`: http://wiki.debian.org/MeetBot
--
-- Pete Travis
- Fedora Docs Project Leader
- 'randomuser' on freenode
- immanetize(a)fedoraproject.org
9 years, 7 months
Re: you documentatoin leads people to download a nasty virus
by Pete Travis
On Sep 19, 2014 10:40 PM, "Chaoyi Zha" <cydrobolt(a)fedoraproject.org> wrote:
>
> Hi,
>
> Can you provide the information that has led you to believe that
> DivHasher is a virus? Based on my research, it seems like a perfectly
> legit application.
>
> Thanks,
>
> --
>
> Chaoyi Zha
> cydrobolt(a)fedoraproject.org
>
>
> On Wed, Sep 17, 2014 at 8:54 PM, Andrew E. Slater <slater126(a)gmail.com>
wrote:
> >
> >
> > On this page:
> >
http://docs.fedoraproject.org/en-US/Fedora/20/html/Burning_ISO_images_to_...
> >
> >
> >
> > You suggest this download
> >
> >
> >
> > DivHasher: http://soft.mydiv.net/DivHasher.html
> >
> >
> >
> >
> >
> > Which leads to a site that totally compromises the users computer
> >
> >
> >
> > Please remove from your site.
> >
> >
> >
> >
> >
> >
> >
> > Regards, Andy
> >
> >
> >
> > Andrew Slater
> >
> > slater126(a)gmail.com
> >
> > 203 292 0002
> >
> >
> >
> > www.twitter.com/SlaterAndrewE
> >
> > www.linkedin.com/in/SlaterAndrewE
> >
> >
> >
> >
> > --
I'm passing this along to the docs list to ensure it gets reviewed by those
responsible for the content. Any elaboration or citations you can provide
will be very helpful, Andy.
--Pete
9 years, 7 months
Re: Release notes have a launcher - maybe we should remove that
by Petr Kovar
On Fri, 5 Sep 2014 07:21:41 -0400 (EDT)
Bastien Nocera <bnocera(a)redhat.com> wrote:
>
>
> ----- Original Message -----
> <snip>
> > What really got my interest was an idea to implement a new GNOME Shell
> > search provider (https://bugzilla.gnome.org/show_bug.cgi?id=690058) that
> > would integrate with Tracker to index locally installed docs (with
> > the search possibly restricted to /usr/share/help/). Similarly to already
> > indexed user documents in ~/Documents or personal contacts, users could
> > then search for locally installed documentation, including the Release
> > Notes, from within the Shell's Activities overview. This would allow for a
> > far better (as in systematic) approach to finding files on the user's
> > desktop, with a neat categorization in the Shell's search results as an
> > added bonus.
>
> Search providers are all backed by applications. What's the application
> to read the docs in /usr/share/help? What would be in there other than the
> release notes?
It could be gnome-documents as Matthias proposed if we choose to ship PDF
instead of a bunch of HTML pages.
It could be yelp as it supports transforming DocBook/Mallard XML as well as
viewing HTML pages. I just tested it and yelp works quite well:
$ yelp /usr/share/doc/fedora-release-notes/index.html
The right thing to do would probably be to move Release Notes
from /usr/share/doc/ to /usr/share/help/. Indexing /usr/share/help/ would
get users easy access to both downstream (Release Notes) as well as upstream
documentation (GNOME Help, application help, GNOME System Admin Guide,
etc.).
> It would probably be better to have those docs be converted to something Yelp
> can read and integrated in the Help, at least for GNOME and for Workstation.
Yes, we could do integration in the GNOME Help. Few things would have to
be figured out, though:
* Whether we want to do this integration upstream with the help of Mallard
conditionals. We would probably need a new test token
(http://projectmallard.org/if/1.0/tokens) for that implemented in yelp.
* Alternatively, we could create a downstream patch. Maintaining this
and figuring out what to do with translations is not something I would
personally want to do. ;)
Cheers,
pk
9 years, 7 months
Writing tip: the oft-forgotten <prompt> tag
by Petr Bokoc
Hi everyone,
We just had a bit of a discussion on IRC and I've been asked to share
this with you all:
The <prompt> tag[1] is awesome, especially in procedures. When you're
telling the reader to run a sequence of commands, you can prefix each
command with the correct prompt; the user will then know if the command
requires root privileges or not, and you don't have to say "run this as
root" all the time.
For example:
1. Install the foo package:
<screen>
<prompt>#</prompt> <command>yum install foo</command>
</screen>
2. Make sure the foo package is installed:
<screen>
<prompt>$</prompt> <command>rpm -q foo</command>
</screen>
This way, the user knows that you need root privileges for the first
command, because it's prefixed with #, and they don't need to be root
for the second one, because the prompt is $. (However, in some simple
procedures explaining very basic stuff to beginners it's still useful to
include a step that says "Switch to root: $ su -".)
Make sure to put a space between the prompt and the actual command -
otherwise it just looks bad when rendered. Also make sure to use the
prompts *everywhere*, because if you only use it for commands that need
root and omit it for ones that don't, it ends up being confusing (and
looking bad). And finally, don't use this when you mention a command
inline (in a <para>) - only in <screen> or <programlisting>.
Please try to keep this in mind when writing. I'm doing this everywhere
in the Installation Guide, and it would be great if we all did the same.
Cheers,
Petr
[1] http://www.docbook.org/tdg/en/html/prompt.html
9 years, 7 months
Separate SELinux stuff from the Security Guide?
by Barbora Ančincová
Hi guys,
I've been thinking, since the trend seems to be to have smaller,
specialized guides, such as the Firewall guide, I would like to propose
to separate SELinux-related chapters from the Security Guide as it is in
RHEL and as it was in Fedora too. One good reason for doing so is that
huge guides are difficult to maintain and also to navigate (Deployment
Guide was a great example). And there is a lot of content in RHEL
SELinux guide that can be propagated to the Fedora version of the guide,
so I do not expect that the guide will get any smaller. Also, as the
maintainer of the SELinux guide for RHEL, I'd like to try to document
things upstream first (= more eyeballs to make bugs shallow :) )
Sparks, what do you think?
Also, sorry for not bringing this up on the meeting, but it seemed we
did not have enough time for the open-floor discussion.
Bara
--
Barbora Ancincova
Technical Writer 1
Customer Content Services
IRC nick: bara
Red Hat Czech, s.r.o.
Purkynova 99
612 45 Brno, Czech Republic
9 years, 7 months
Fedora Docs Meeting Minutes 15 Sep 2014
by Pete Travis
====================================================================================================
#fedora-meeting: Docs Project Meeting - Agenda: https://fedoraproject.org/wiki/Docs_Project_meetings
====================================================================================================
Meeting started by pbokoc at 14:07:43 UTC. The full logs are available
at
http://meetbot.fedoraproject.org/fedora-meeting/2014-09-15/fedora_docs.20...
.
Meeting summary
---------------
* Roll Call (pbokoc, 14:08:17)
* Follow up on last week's action items (randomuser, 14:16:00)
* ACTION: randomuser to send mail to list regarding beats status
(randomuser, 14:16:39)
* New Writers (randomuser, 14:16:53)
* Release Notes / Beats (randomuser, 14:23:41)
* LINK:
https://fedorapeople.org/groups/schedule/f-21/f-21-docs-tasks.html
(randomuser, 14:24:00)
* LINK:
https://fedoraproject.org/wiki/Category:Documentation_beats?rd=Documentat...
(randomuser, 14:24:50)
* Scheduled time for open beat writing is closing - don't hold back!
(randomuser, 14:28:24)
* Guide Status (randomuser, 14:38:29)
* multiboot-guide plans developing at
https://fedoraproject.org/wiki/Multiboot_guide_whiteboard
(randomuser, 14:53:04)
* LINK: http://red.ht/1s2GmSK (pbokoc, 14:57:17)
* task list for the IG: http://red.ht/1s2GmSK - if you want to help,
find something in there and ping pbokoc if you need any
details/direction (pbokoc, 14:58:18)
* Open Floor DIscussion (randomuser, 14:58:27)
Meeting ended at 15:00:45 UTC.
Action Items
------------
* randomuser to send mail to list regarding beats status
Action Items, by person
-----------------------
* randomuser
* randomuser to send mail to list regarding beats status
* **UNASSIGNED**
* (none)
People Present (lines said)
---------------------------
* randomuser (78)
* pbokoc (27)
* RogerB_TX (10)
* Capesteve (10)
* zodbot (7)
* Sparks (7)
* bara_ (6)
* kollex (3)
* jhradilek (2)
* jsmith (2)
* yruseva (1)
* rkratky (1)
* jhunt (1)
* jreznik (1)
Generated by `MeetBot`_ 0.1.4
.. _`MeetBot`: http://wiki.debian.org/MeetBot
--
-- Pete Travis
- Fedora Docs Project Leader
- 'randomuser' on freenode
- immanetize(a)fedoraproject.org
9 years, 7 months