From Fedora Project Wiki
Line 140: Line 140:


<code>git-format-patch</code>  to generate a patch file
<code>git-format-patch</code>  to generate a patch file
reverting: <code>git reset</code>


more recommended documentation: [[http://book.git-scm.com/ Git Community Book]]
more recommended documentation: [[http://book.git-scm.com/ Git Community Book]]

Revision as of 20:26, 10 January 2009

I am just getting started with Fedora Docs.

Current Projects

As I get started and learn the tools, I hope to help document the processes/workflow so it is easier for other people to also get started.

Over the holiday and through the hackfest and FUDcon, I will add tips and reminders here.

communication

guides

packages/technologies

FUDCON

links


  • wikipedia style manual for more organization tips

QandA

  • Question: why cms instead of wiki?
    • really it is not instead of - it is in addition to...
    • wiki - quick collaboration, easily updated, frequently changing, end-users
    • cms - more static content that must be in xml (docs) and transated and more restricted content like packaging and legal and logos. and lifecycle tracking - to end of life version specific content.

wiki Pagenaming/style tip

  • page can only be in one namespace but can have multi categories.
  • level1 headers are deprecated and bad bad bad - (page name can have spaces so name your page the level1 headers)
  • first thing should not be section header so you get an intro para THEN the table of contents in intro mention that title (in bold). From mediawiki style guide.
  • put category at the bottom of page
  • can we find pages with a l1 header - and rename page using l1 header and remove l1 header
  • look at [fonts] as how category page can have it's own content. uses templates to then list all pages within that category.

Docbook presentation notes

Note: This is just what is new to me and I have used docbook before so ... so it is not all notes from the talk . See above for link to docbook documentation.

  • do not forget the declaration for xml DOCTYPE docbook.dtd at the beginning.
    • it may be used by tools (validators) or created by tools (Publican)
    • it is used for validation
    • we are using V4.4
    • cut and paste - but note book vs article
  • first element must match declaration (book vs article)
  • Xincludes
    • helps with repurposing content
    • ie each chapter is in its own file. then the book/article just includes with appropriate chapters.
    • can include any type - chapter, para, ...
  • ENTITY
    • define the entity !ENTITY DISTRO "The Susan spin of Fedora"
      • inline or through a reference to a separate file (.ent file)
    • publican will auto include (and use fedora-branding for this and more)
    • use as &DISTRO; in content
  • tools tools (for any xml not just docbook)
    • xmlint - does it follow the dtd
    • xsltproc - transforms to other types like pdf or html
    • xmltidy
  • toolchains
    • lots of older one and custom one.
    • Fedora now including and using Publican
  • file.xml -> xsltproc -> file.fo -> fop -> file.pdf
    • xsltproc read in style sheet
    • fo is about layout
  • publican
    • can create template
create_book --brand=fedora --type=article --name=article2

git for dummies by dummies

 yum install git-all

git-config program is deprecated 

git config --global user.name 'Susan Lauber'
  • writes out to .gitconfig
  • I missed Paul's list of other global settings as a minimum

Get a copy of a repo

  • make a directory for your copy then clone the repo
git clone ssh://git.fedorahosts.org/git/docs/install-guide
  • uses the .git subdir to hold objects, logs, info, branches, refs, and more
  • .git/hooks include scripts
  • .git/branches are low overhead, easy, very useful
  • .git/HEAD points to tip of history

..missing stuff.. while checking gpg fingerprints...

useful git commands:

  • status
  • diff and diff --cached (from the "mob teaches Paul" series)
  • add
  • commit and commit -a

during commit edit msg

  • first line,keep it short (summery and email subject)
  • skip a line then type a longer log (details and email body)

git commit is just committing to local repo git push actually pushes up

git-format-patch to generate a patch file

reverting: git reset

more recommended documentation: [Git Community Book]

Self Introduction

Greetings,

I have been meaning to get more involved with fedoraproject for a while and I have been lurking here on the docs list for a few weeks now. I was struggling a little to figure out how this project worked but then I rescued about 50 messages from my spam folder and it is now starting to make more sense :)

I have been a contract instructor for Red Hat since 2000 and involved in network operating system support and training since 1992 (and *nix user even longer). I have contributed to Red Hat course materials including general bug reports, testing updated labs, helping to update the online training from RHEL3 to RHEL4, and providing content for the first release of Red Hat Academy materials.

The Red Hat Academy project involved working with DocBook. I have taught and used cvs, seen subversion, and am sure I can figure out git relatively quickly. I am not as versed in wiki and irc etiquette and usage but I have been poking around and reading some of the intro and FAQ docs and of course I have had plenty of experience with mailing lists and AIM.

And for all that I use and recommend opensource, this is the first project I have actually joined (better late then never I guess).

I am interested in all things related to learning and teaching - documentation, corporate training, university settings, and youngsters too.

I am also lurking on the OLPC list and as a longer term goal, I would like to learn more about packaging.

-Susan 

pub   1024D/BFA10974 2005-12-13
      Key fingerprint = 15AC F794 A3D9 64D1 D9CE  4C26 EFC3 11C2 BFA1 0974
uid                  Lauber System Solutions, Inc. <lauber@ties.org>
uid                  Susan Lauber <susan@ties.org>
uid                  Susan Lauber <laubersm@gmail.com>
uid                  Susan Lauber <sml@laubersolutions.com>
sub   2048g/6425FFD3 2005-12-13

-- Susan Lauber, (RHCX, RHCA, RHCSS)
Lauber System Solutions, Inc.
http://www.laubersolutions.com
gpg: 15AC F794 A3D9 64D1 D9CE 4C26 EFC3 11C2 BFA1 0974

Retrieved from "https://fedoraproject.org/w/index.php?title=User:Laubersm&oldid=69758"