From d1db00d34c1a49440d73f453c9e6d35cccb1c792 Mon Sep 17 00:00:00 2001 From: Alain Reguera Delgado Date: Mar 02 2011 04:30:03 +0000 Subject: Update repository documentation manual. --- diff --git a/Manual/Introduction/chapter-intro.texi b/Manual/Introduction/chapter-intro.texi index 60a64ad..2952ec3 100644 --- a/Manual/Introduction/chapter-intro.texi +++ b/Manual/Introduction/chapter-intro.texi @@ -1 +1,27 @@ -Welcome to CentOS Artwork Repository. +Welcome to the @emph{CentOS Artwork Repository Manual}. + +The CentOS Artwork Repository Manual contains information on how to +produce the CentOS Corporate Visual Identity inside the CentOS Artwork +Repository (@url{https://projects.centos.org/svn/artwork/}). If you +are looking for a comprehensive, task-oriented guide for understanding +how the CentOS Corporate Visual Identity is produced, this is the +manual for you. + +This manual discusses the following intermedite topics: + +@itemize +@item The CentOS Brand +@item The CentOS Corporate Visual Structure +@item The CentOS Corporate Visual Style +@end itemize + +This manual is divided into the following main categories: + +@itemize +@item The Repository File System +@end itemize + +This guide assumes you have a basic understanding of your CentOS +system. If you need help with CentOS, refer to the help page on the +CentOS Wiki (@url{http://wiki.centos.org/Help}) for a list of +different places you can find help. diff --git a/Manual/Introduction/convenctions.texi b/Manual/Introduction/convenctions.texi index 226dbb1..a46a23e 100644 --- a/Manual/Introduction/convenctions.texi +++ b/Manual/Introduction/convenctions.texi @@ -15,8 +15,9 @@ in a different style on their own (such as file names). In these cases, they are considered to be part of the command, so the entire phrase is displayed as a command. For example: -Use the @command{cat testfile} command to view the contents of a file, -named testfile, in the current working directory. +Use the @command{centos-art identity --render='path/to/dir'} command +to produce contents inside the @file{trunk/Identity} directory +structure. @end table @table @file @@ -26,14 +27,12 @@ File names, directory names, paths, and RPM package names are represented this way. This style indicates that a particular file or directory exists with that name on your system. Examples: -The @file{.bashrc} file in your home directory contains bash shell -definitions and aliases for your own use. +The @file{init.sh} file in @file{trunk/Scripts/Bash/Cli/} directory is +the initialization script, written in Bash, used to automate most of +tasks in the repository. -The @file{/etc/fstab} file contains information about different system -devices and file systems. - -Install the @file{webalizer} RPM if you want to use a Web server log -file analysis program. +The @command{centos-art} command uses the @file{ImageMagick} RPM +package to convert images from PNG format to many different formats. @end table @table @key @@ -44,15 +43,18 @@ A key on the keyboard is shown in this style. For example: To use @key{TAB} completion to list particular files in a directory, type @command{ls}, then a character, and finally the Tab key. Your terminal displays the list of files in the working directory that -begin with that character. key-combination +begin with that character. +@end table +@table @key +@item key-combination A combination of keystrokes is represented in this way. For example: The @key{Ctrl-Alt-Backspace} key combination exits your graphical session and returns you to the graphical login screen or the console. @end table -@table @command +@table @code @item computer output Text in this style indicates text displayed to a shell prompt such as diff --git a/Manual/Introduction/feedback.texi b/Manual/Introduction/feedback.texi index 2946c8a..6a1a6c1 100644 --- a/Manual/Introduction/feedback.texi +++ b/Manual/Introduction/feedback.texi @@ -1,7 +1,7 @@ - If you find an error in the @emph{CentOS Artwork Repository}, or if - you have thought of a way to make this manual better, we would like - to hear from you! Create a new ticket in artwork project - (@url{http://projects.centos.org/trac/artwork/}). + If you find an error in the @emph{CentOS Artwork Repository Manual}, + or if you have thought of a way to make this manual better, we would + like to hear from you! Create a new ticket in artwork project + (@url{https://projects.centos.org/trac/artwork/}). If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the diff --git a/Manual/repository-html/repository.html b/Manual/repository-html/repository.html index 9a86894..19dc38f 100644 --- a/Manual/repository-html/repository.html +++ b/Manual/repository-html/repository.html @@ -1,6 +1,9 @@ - + This manuals documents relevant information regarding the deployment, organization, and administration of CentOS Artwork Repository. Copyright ©right; 2009-2011 Alain Reguera Delgado Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License. @@ -11,6 +12,7 @@ CentOS Artwork Repository Manual Alain Reguera Delgado + This manuals documents relevant information regarding the deployment, organization, and administration of CentOS Artwork Repository. Copyright ©right; 2009-2011 Alain Reguera Delgado Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License. @@ -21,6 +23,7 @@ (dir) CentOS Artwork Repository + This manuals documents relevant information regarding the deployment, organization, and administration of CentOS Artwork Repository. Copyright ©right; 2009-2011 Alain Reguera Delgado Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled GNU Free Documentation License. @@ -55,7 +58,29 @@ Top Introduction - IntroductionWelcome to CentOS Artwork Repository. + IntroductionWelcome to the CentOS Artwork Repository Manual. + The CentOS Artwork Repository Manual contains information on how to produce the CentOS Corporate Visual Identity inside the CentOS Artwork Repository (https://projects.centos.org/svn/artwork/). If you are looking for a comprehensive, task-oriented guide for understanding how the CentOS Corporate Visual Identity is produced, this is the manual for you. + This manual discusses the following intermedite topics: + + • + + The CentOS Brand + + + The CentOS Corporate Visual Structure + + + The CentOS Corporate Visual Style + + + This manual is divided into the following main categories: + + • + + The Repository File System + + + This guide assumes you have a basic understanding of your CentOS system. If you need help with CentOS, refer to the help page on the CentOS Wiki (http://wiki.centos.org/Help) for a list of different places you can find help. Convenctions @@ -82,7 +107,7 @@ command Linux commands (and other operating system commands, when used) are represented this way. This style should indicate to you that you can type the word or phrase on the command line and press Enter to invoke a command. Sometimes a command contains words that would be displayed in a different style on their own (such as file names). In these cases, they are considered to be part of the command, so the entire phrase is displayed as a command. For example: - Use the cat testfile command to view the contents of a file, named testfile, in the current working directory. + Use the centos-art identity --render='path/to/dir' command to produce contents inside the trunk/Identity directory structure. @@ -91,9 +116,8 @@ file name File names, directory names, paths, and RPM package names are represented this way. This style indicates that a particular file or directory exists with that name on your system. Examples: - The .bashrc file in your home directory contains bash shell definitions and aliases for your own use. - The /etc/fstab file contains information about different system devices and file systems. - Install the webalizer RPM if you want to use a Web server log file analysis program. + The init.sh file in trunk/Scripts/Bash/Cli/ directory is the initialization script, written in Bash, used to automate most of tasks in the repository. + The centos-art command uses the ImageMagick RPM package to convert images from PNG format to many different formats. @@ -102,7 +126,14 @@ key A key on the keyboard is shown in this style. For example: - To use TAB completion to list particular files in a directory, type ls, then a character, and finally the Tab key. Your terminal displays the list of files in the working directory that begin with that character. key-combination + To use TAB completion to list particular files in a directory, type ls, then a character, and finally the Tab key. Your terminal displays the list of files in the working directory that begin with that character. + + + + + + key-combination + A combination of keystrokes is represented in this way. For example: The Ctrl-Alt-Backspace key combination exits your graphical session and returns you to the graphical login screen or the console. @@ -110,7 +141,7 @@
- computer output + computer output Text in this style indicates text displayed to a shell prompt such as error messages and responses to commands. For example: The ls command displays the contents of a directory. For example: @@ -147,7 +178,7 @@ manual_deleteCrossReferences.sh manual_searchIndex.sh Introduction
Send in Your Feedback - Feedback If you find an error in the CentOS Artwork Repository, or if you have thought of a way to make this manual better, we would like to hear from you! Create a new ticket in artwork project (http://projects.centos.org/trac/artwork/). + Feedback If you find an error in the CentOS Artwork Repository Manual, or if you have thought of a way to make this manual better, we would like to hear from you! Create a new ticket in artwork project (https://projects.centos.org/trac/artwork/). If you have a suggestion for improving the documentation, try to be as specific as possible. If you have found an error, include the section number and some of the surrounding text so we can find it easily.