[PATCH 0/6] Updating developer documentation
Shawn Wells
shawn at redhat.com
Tue May 13 19:41:22 UTC 2014
On 5/13/14, 2:21 PM, David Smith wrote:
> This additional documentation will definitely be needed -- ack x6
pushed:
$ git push
Enter passphrase for key '/home/shawnw/.ssh/id_rsa':
Counting objects: 136, done.
Delta compression using up to 2 threads.
Compressing objects: 100% (104/104), done.
Writing objects: 100% (104/104), 289.24 KiB, done.
Total 104 (delta 65), reused 0 (delta 0)
To ssh://shawndwells@git.fedorahosted.org/git/scap-security-guide.git
f1a0d13..5db8e06 master -> master
>
>
> On Mon, May 12, 2014 at 2:22 AM, Shawn Wells <shawn at redhat.com
> <mailto:shawn at redhat.com>> wrote:
>
> A number of updates to the Developer Guide documentation. Namely:
> - Incorporated Jan's RPM build instructions into DocBook and the
> Developer guide. It's a first cut, and marked as draft. Gives us
> something to edit from;
> - To prepare for, and ease, the transition to GitHub, I generated
> some basic user guides on cloning and patching/"pull requests"
>
> Things staged @
> http://people.redhat.com/swells/docs/en-US/SCAP_Security_Guide/0.1/html-single/Developer_Guide/index.html
> (note: don't bookmark that URL. it's just scratch space. real docs
> will be @ docs.ssgproject.org <http://docs.ssgproject.org> once ack'd)
>
>
> Shawn Wells (6):
> Updated docs Makefile to embed TOC
> Updated docs TOC
> Updated Developer Guide - Accounts
> Updated Developer Guide - Patching
> Updated Developer guide - RPM build
> Updating master documentation TOC
>
> docs/Developer_Guide/en-US/Developer_Guide.xml | 3 +
> docs/Developer_Guide/en-US/ch001-Accounts.xml | 37 +++
> docs/Developer_Guide/en-US/ch002-Patching.xml | 110 +++++++++
> docs/Developer_Guide/en-US/ch003-RPM_Build.xml | 236
> ++++++++++++++++++++
> .../en-US/images/._ch002-Patching-Base_Fork.png | Bin 0 ->
> 4096 bytes
> .../._ch002-Patching-Compare_Against_Forks.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-Create_Pull.png | Bin 0 ->
> 4096 bytes
> .../._ch002-Patching-GUI_naming_scheme_sample.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-Head_Fork.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-New_Pull.png | Bin 0 ->
> 4096 bytes
> .../images/._ch002-Patching-Pull_Requests.png | Bin 0 ->
> 4096 bytes
> .../images/._ch002-Patching-Send_Pull_Request.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-fork.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-forklocation.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-githubURL.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Patching-inline_edits.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/._ch002-Pull_Request.png | Bin 0 ->
> 4096 bytes
> .../en-US/images/ch002-Patching-Base_Fork.png | Bin 0 ->
> 24742 bytes
> .../ch002-Patching-Compare_Against_Forks.png | Bin 0 ->
> 13398 bytes
> .../en-US/images/ch002-Patching-Create_Pull.png | Bin 0 ->
> 27090 bytes
> .../ch002-Patching-GUI_naming_scheme_sample.png | Bin 0 ->
> 16138 bytes
> .../en-US/images/ch002-Patching-Head_Fork.png | Bin 0 ->
> 26322 bytes
> .../en-US/images/ch002-Patching-New_Pull.png | Bin 0 ->
> 9916 bytes
> .../en-US/images/ch002-Patching-Pull_Requests.png | Bin 0 ->
> 35141 bytes
> .../images/ch002-Patching-Send_Pull_Request.png | Bin 0 ->
> 23685 bytes
> .../en-US/images/ch002-Patching-fork.png | Bin 0 ->
> 9044 bytes
> .../en-US/images/ch002-Patching-forklocation.png | Bin 0 ->
> 52539 bytes
> .../en-US/images/ch002-Patching-githubURL.png | Bin 0 ->
> 10156 bytes
> .../en-US/images/ch002-Patching-inline_edits.png | Bin 0 ->
> 19339 bytes
> .../en-US/images/ch002-Pull_Request.png | Bin 0 ->
> 22963 bytes
> docs/Makefile | 6 +-
> docs/html/Sitemap | 36 ++--
> docs/html/en-US/toc.html | 1 +
> docs/ssg-docs.db | Bin 5120 ->
> 5120 bytes
> 34 files changed, 408 insertions(+), 21 deletions(-)
> create mode 100644 docs/Developer_Guide/en-US/ch001-Accounts.xml
> create mode 100644 docs/Developer_Guide/en-US/ch002-Patching.xml
> create mode 100644 docs/Developer_Guide/en-US/ch003-RPM_Build.xml
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Base_Fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Compare_Against_Forks.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Create_Pull.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-GUI_naming_scheme_sample.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Head_Fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-New_Pull.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Pull_Requests.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-Send_Pull_Request.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-forklocation.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-githubURL.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Patching-inline_edits.png
> create mode 100644
> docs/Developer_Guide/en-US/images/._ch002-Pull_Request.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Base_Fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Compare_Against_Forks.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Create_Pull.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-GUI_naming_scheme_sample.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Head_Fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-New_Pull.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Pull_Requests.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-Send_Pull_Request.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-fork.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-forklocation.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-githubURL.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Patching-inline_edits.png
> create mode 100644
> docs/Developer_Guide/en-US/images/ch002-Pull_Request.png
>
> _______________________________________________
> scap-security-guide mailing list
> scap-security-guide at lists.fedorahosted.org
> <mailto:scap-security-guide at lists.fedorahosted.org>
> https://lists.fedorahosted.org/mailman/listinfo/scap-security-guide
>
>
>
>
> --
> David Smith
> Sr. Information Security Engineer
> Secure Innovations, LLC
>
>
> _______________________________________________
> scap-security-guide mailing list
> scap-security-guide at lists.fedorahosted.org
> https://lists.fedorahosted.org/mailman/listinfo/scap-security-guide
--
Shawn Wells
Director, Innovation Programs
shawn at redhat.com | 443.534.0130
@shawndwells
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.fedorahosted.org/pipermail/scap-security-guide/attachments/20140513/ab322530/attachment-0001.html>
More information about the scap-security-guide
mailing list