From b637d7890ef6ee13c10cd24a412678921dd6f409 Mon Sep 17 00:00:00 2001 From: rsoulliere Date: Wed, 2 Mar 2011 07:52:36 -0500 Subject: [PATCH] Remove cronjobs section with missing attributions: https://bugs.launchpad.net/bugs/727595 --- 1.6/admin/AdminMisc.xml | 20 +++--- style_guide/contributing_DIG.xml | 104 +++++++++++++++++++++++++++++++ style_guide/root.xml | 7 +-- 3 files changed, 116 insertions(+), 15 deletions(-) create mode 100644 style_guide/contributing_DIG.xml diff --git a/1.6/admin/AdminMisc.xml b/1.6/admin/AdminMisc.xml index a5b4448426..5ed09e1ddf 100644 --- a/1.6/admin/AdminMisc.xml +++ b/1.6/admin/AdminMisc.xml @@ -92,10 +92,7 @@ Create a bash script for starting Evergreen and all associated services. Here is an example script: - - - +]]> Save file in /etc/bin folder as evergreenstart if you would like this as a manual script for starting Evergreen services. @@ -310,10 +306,16 @@ esac; /etc/init.d/apache2 restart - The next steps are optional if you want to automate Evergreen so it starts during your server's boot process. - Update runlevel defaults of the new evergreenstart service as the root user: + + The next steps are optional if you want to automate Evergreen so it starts during your server's boot process. + + Update runlevel defaults of the new evergreenstart service as the root user: update-rc.d evergreenstart defaults 80 20 -For Evergreen to start properly during a reboot, you will want to ensure that the first number is lower than the assigned starting priority for Apache so it starts before Apache. It should also a higher stopping priority than Apache so it stops after Apache at shutdown. + + For Evergreen to start properly during a reboot, you will want to ensure that the first number () is lower than the assigned + starting priority for Apache, so it starts before Apache. It should also have a larger stopping priority number () than Apache so it stops + after Apache during a boot cycle. + Test the startup script by rebooting the Evergreen Server and checking to ensure that all Evergreen sercices started properly. diff --git a/style_guide/contributing_DIG.xml b/style_guide/contributing_DIG.xml new file mode 100644 index 0000000000..6f1bf5fc2b --- /dev/null +++ b/style_guide/contributing_DIG.xml @@ -0,0 +1,104 @@ + + + + Contributing Documentation in DocBook Format + + +
+ Evergreen Documentation File Structure + + At the root of the Evergreen documentation is the root.xml file. The file contains the <book> element and manages the organization of the + Evergreen Documentation Manual. This file contains included files which are the chapters and the appendices of the documentation. If you are contributing documentation, you should not + have to edit this file except to add an include statement to place a new chapter in the Evergreen documentation in appropriate order: + +... +]]> + The above example includes the glossary.xml file in the Evergreen documentation. This file should be located in the + appendixes subdirectory relative to the root.xml file. + When creating new files, the first line should always be: + +]]> + This is the standard to indicate that this is an XML file + The next line should include the <chapter> element. Here is an example for the glossary chapter of this style guide document. + +]]> + An important attribute is xml:id. This must be a unique id to the entire documentation and is important for cross referencing chapters, sections, tables + and other parts of the documentation. + Also remember to add the closing </chapter< tag at the very end of the document. + The chapter is the container for files contributed to DIG. Do not create a new file to add a <section> to an existing + <chapter> and do not use the <book> container in yor file since the + <book> element is already in the root.xml file. +
+
+ How to Contribute Documentation + + Using Git to Upload Files from Linux + + Install git. + + + Sign up for a free github account.. + + + Send an email to the github repository maintainer (robert.soulliere@mohawkcollege.ca) to request being added as a contributor. + + + Generate and add SSH keys to github repository.. + + + Clone the Evergreen-DocBook repository on your local machine: +git clone git://github.com/rsoulliere/Evergreen-DocBook.git + + + Edit or add files in the clonesd repository location. + + + For editing and committing changes to the repository there are only a handful of commands you need to know (run these inside the directory structure of your cloned + repository): + + git pull - It will pull the most recent changes into your cloned version to avoid merging + issues and errors when pushing your changes tp the remote repository. + git add - Adds new files to repository. This is needed to tell git that you have added or edited files and want to add + them into the repo. + git commit - Commits changes to the repository. A text file will open describing what will be committed. Add a + meainingful note here to indicate + what you have chanaged. + git push - Push changes to remote repository. After pushing your changes you should see them show up at: + + https://github.com/rsoulliere/Evergreen-DocBook/commits/master. + + If possible, please test files locally or verify DocBook syntax is correct. The docBook files are generated every night to update the HTML and PDF files. + Incorrect DocBook syntax could cause the chapter to be skipped during processing and not be included in the documentation. + + Contributing by editing existing files on github + + Editing files directly in github using the following procedures is not recommended for larger changes, but is useful for quick typo corrections and other + minor edits. If you need to makke major changes please use the previous git method or send changes to the + DIG list. + Sign up for a free github account.. + + + Send an email to the repository maintainer (robert.soulliere@mohawkcollege.ca) to request being added as a contributor. + + + Go to the github repository at https://github.com/rsoulliere/Evergreen-DocBook + + + Navigate to the file you would like to edit and click Edit this file + + + Make changes, enter your change notes in the Commit message box and click Commit Changes. + + + If you are unconfortable committing Documentation in DocBook format, simply submit your text documents or suggested changes to the + DIG list and we will convert them to XML DocBook format + or add your changes to the documentation. +
+ diff --git a/style_guide/root.xml b/style_guide/root.xml index dc27c663e3..4284b5f10a 100644 --- a/style_guide/root.xml +++ b/style_guide/root.xml @@ -28,15 +28,10 @@ - + - - - - - -- 2.43.2