Here is what I put together from our chat yesterday. Could you please review and tell me if I missed anything or if there is something you would like to add to it. I will be using this as a ready-ref as I get myself bootstrapped. Thank you in advance -- Warm Regards, Roger Baran, Owner Rapid Recovery IT Services San Antonio, TX
You can send anything to the docs list; however i think it would be most effective to work your content into the multiboot guide we have already started Ref's: http://www.docbook.org/ https://git.fedorahosted.org/cgit/docs/documentation-guide.git/ https://admin.fedoraproject.org/accounts https://git.fedorahosted.org/cgit/docs/multiboot-guide.git yum install git publican publican-fedora git clone https://git.fedorahosted.org/git/docs/multiboot-guide.git cd into the multiboot guide directory (Note: publican.cfg defines the project, and the en-US directory contains the doc's XML) publican print_tree -- to see document structure publican build --langs en-US --formats html-single -- will build the document as others will see it using HTML; -- it creates a 'tmp' directory for the output; you can open it with ie `firefox tmp/en-US/html-single/index.html cat en-US/Fedora_Multiboot_Guide.xml -- displays the root file for the guide (review overall structure) cat en-US/BOOT-BIOS_or_UEFI.xml -- displays an individual file (section) that will be included in the guide (review section structure) Under the <article> we have <sections>; the sections have an 'id' attribute that you can use for links; sections always have a title inside the sections we put whatever structural elements are appropriate; paragraphs, lists, notes, etc The important thing to remember is that XML tags must always be closed, like this: <para>words</para> and there are rules about what elements can be parents of others, and what they can be children of It's a lot easier to write first, and mark up later; if you keep the structure very basic Edit and save one of the files and then go back to the terminal... now, we want to tell git to create a 'branch' for your work; the branch will give you a personal workspace, and a way to track your changes against the 'master' branch: git branch callitwhatyouwantitisyourbranch Then check out your branch: git checkout branchname First time around you need to configure yourself with git: git config --global user.name "Roger ROgerslastname" git config --global user.email "your@email" Edit the files, and when ready to commit them to the guide use: git commit en-US/UEFI.xml -m "some message that explains to your fellow contributors the change you are committing" If you had commit privileges, you could do 'git push' and everyone would get those changes when the did a 'git pull' Until then, do this: `git format-patch master` it will create one file for each commit in your branch you can email those files to me, or to the docs list, and we can apply them to the repo and bring your changes into the master branch To get started: Create a branch for a specific task, ie 'git branch uefibootmgr-instructions'; then make a series of edits and commits related to that task When they are applied, you can check out the master branch and do a `git pull`; then, go back to your private branch and `git merge master` will bring it back in sync. Or, you can declare the work done and start a new branch after your branch is merged in. The main utility of having a separate branch from master is to generate that delta file. After that, it's whatever organizational structure seems appropriate; convention is to branch based on intent
Attachment:
signature.asc
Description: This is a digitally signed message part
-- docs mailing list docs@xxxxxxxxxxxxxxxxxxxxxxx To unsubscribe: https://admin.fedoraproject.org/mailman/listinfo/docs
