Creating A New NST Script - Revision history

Paul Blankenbaker: /* Updating Links/Menu Entries */

2011-03-04T14:55:41Z

Updating Links/Menu Entries

← Older revision		Revision as of 10:55, 4 March 2011
Line 157:		Line 157:
	; yum/pkgs/nstwui/template.spec		; yum/pkgs/nstwui/template.spec
	: You will need to add a change log entry.		: You will need to add a change log entry.

			= Update A NST Distro Package =

			In order for the new script to appear in the ISO distribution, you will need to add it to ''one'' of the following files:

			; yum/pkgs/nst-required/pkginfo.xml
			: Add your script's package name to this file if the script must remain on a NST system in order for the NST system to function properly.
			; yum/pkgs/nst-live/pkginfo.xml
			: Add your script's package name to this file if it is a ''optional'' script which the end user can remove from their NST system and still expect the NST system to function properly.

	= Updating the NST Web Site =		= Updating the NST Web Site =

Paul Blankenbaker: /* Files You Should Add To svn:ignore */

2011-03-03T23:03:31Z

Files You Should Add To svn:ignore

← Older revision		Revision as of 19:03, 3 March 2011
Line 121:		Line 121:
	: This file will need to be updated (at a minimum you will want to edit the ''%description'' area). This is the template file that is used to generate the final spec file during the packaging stage of your script.		: This file will need to be updated (at a minimum you will want to edit the ''%description'' area). This is the template file that is used to generate the final spec file during the packaging stage of your script.

	= ~~Files You Should Add To~~ svn:ignore =		= Editing svn:ignore =

	Unfortunately, there will be temporary files generated under the ''src/getipv6'' directory when you build the new ''nst-getipv6'' package. You will need to run the following commands to tell Subversion to ignore these temporary files:		Unfortunately, there will be temporary files generated under the ''src/getipv6'' directory when you build the new ''nst-getipv6'' package. You will need to run the following commands to tell Subversion to ignore these temporary files:

Paul Blankenbaker: /* Updating the NST Web Site */

2011-03-03T23:02:47Z

Updating the NST Web Site

← Older revision		Revision as of 19:02, 3 March 2011
Line 162:		Line 162:
	Once you have finalized your script, you will want to publish it on the Internet at the NST web site. To accomplish this, change to the top level directory of your NST source tree and run the following commands:		Once you have finalized your script, you will want to publish it on the Internet at the NST web site. To accomplish this, change to the top level directory of your NST source tree and run the following commands:

			[root@nstdev32 trunk]# yum update

			... Output from the yum update - should install the latest nstmenu package if necessary ...

	[root@nstdev32 trunk]# ./configure --on-line-docs		[root@nstdev32 trunk]# ./configure --on-line-docs

Paul Blankenbaker: /* Updating Links/Menu Entries */

2011-03-03T22:57:42Z

Updating Links/Menu Entries

← Older revision		Revision as of 18:57, 3 March 2011
Line 157:		Line 157:
	; yum/pkgs/nstwui/template.spec		; yum/pkgs/nstwui/template.spec
	: You will need to add a change log entry.		: You will need to add a change log entry.

			= Updating the NST Web Site =

			Once you have finalized your script, you will want to publish it on the Internet at the NST web site. To accomplish this, change to the top level directory of your NST source tree and run the following commands:

			[root@nstdev32 trunk]# ./configure --on-line-docs

			... A lot of output as your development area is re-configured to generate web site documentation ...

			[root@nstdev32 trunk]# cd docs
			[root@nstdev32 docs]# make scripts.html scripts.upload

			... A lot of output as HTML pages for the NST scripts are generated and uploaded to the web site ...

			[root@nstdev32 docs]# cd ..
			[root@nstdev32 trunk]# make html-build-upload

			... A lot of output as it configures the system for uploading HTML to the web site,
			builds and uploads the HTML and then configures the system back for development ...

			[root@nstdev32 trunk]#

Paul Blankenbaker: /* Updating Links/Menu Entries */

2011-03-03T22:43:43Z

Updating Links/Menu Entries

← Older revision		Revision as of 18:43, 3 March 2011
Line 151:		Line 151:
	; yum/pkgs/nstmenu/pkginfo.xml		; yum/pkgs/nstmenu/pkginfo.xml
	: You will need to bump the release number for this package as the menus will have changed.		: You will need to bump the release number for this package as the menus will have changed.
			; yum/pkgs/nstmenu/template.spec
			: You will need to add a change log entry.
	; yum/pkgs/nstwui/pkginfo.xml		; yum/pkgs/nstwui/pkginfo.xml
	: You will need to bump the release number for this package as the links on the index page will have changed.		: You will need to bump the release number for this package as the links on the index page will have changed.
			; yum/pkgs/nstwui/template.spec
			: You will need to add a change log entry.

Paul Blankenbaker: /* Updating Links/Menu Entries */

2011-03-03T22:36:10Z

Updating Links/Menu Entries

← Older revision		Revision as of 18:36, 3 March 2011
Line 149:		Line 149:
	; wui/index.cgi		; wui/index.cgi
	: The main index page of the NST WUI which has a list of NST script links.		: The main index page of the NST WUI which has a list of NST script links.
			; yum/pkgs/nstmenu/pkginfo.xml
			: You will need to bump the release number for this package as the menus will have changed.
			; yum/pkgs/nstwui/pkginfo.xml
			: You will need to bump the release number for this package as the links on the index page will have changed.

Paul Blankenbaker: /* Files You Should Edit */

2011-03-03T22:19:34Z

Files You Should Edit

← Older revision		Revision as of 18:19, 3 March 2011
Line 107:		Line 107:

	; test/getipv6/test.bash		; test/getipv6/test.bash
	: This script is used to test your new script. You should edit this file to perform automated tests and validation steps whenever possible. It is assumed that the test will be run on fresh NST live boot and while your test does not need to restore the system to the initial state in which it found it, it should not modify the system in such a manner as to cause a different test case to fail. There are ''many'' helper test functions. See the heavily commented [~~include/test/test_functions.bash~~ http://nst.svn.sourceforge.net/viewvc/nst/trunk/test/include/test_functions.bash?revision=HEAD&view=markup] file.		: This script is used to test your new script. You should edit this file to perform automated tests and validation steps whenever possible. It is assumed that the test will be run on fresh NST live boot and while your test does not need to restore the system to the initial state in which it found it, it should not modify the system in such a manner as to cause a different test case to fail. There are ''many'' helper test functions. See the heavily commented [http://nst.svn.sourceforge.net/viewvc/nst/trunk/test/include/test_functions.bash?revision=HEAD&view=markup include/test/test_functions.bash] file.
	; src/scripts/getipv6/getipv6.sh		; src/scripts/getipv6/getipv6.sh
	: This is where you put the ''meat'' of your script. It will be adjusted to source in some common bash function files from the ''/usr/share/nst-bash/'' directory based on the ''INCLUDES'' setting in the ''makefile''.		: This is where you put the ''meat'' of your script. It will be adjusted to source in some common bash function files from the ''/usr/share/nst-bash/'' directory based on the ''INCLUDES'' setting in the ''makefile''.

Paul Blankenbaker: /* Files You Should Edit */

2011-03-03T22:18:35Z

Files You Should Edit

← Older revision		Revision as of 18:18, 3 March 2011
Line 107:		Line 107:

	; test/getipv6/test.bash		; test/getipv6/test.bash
	: This is the test		: This script is used to test your new script. You should edit this file to perform automated tests and validation steps whenever possible. It is assumed that the test will be run on fresh NST live boot and while your test does not need to restore the system to the initial state in which it found it, it should not modify the system in such a manner as to cause a different test case to fail. There are ''many'' helper test functions. See the heavily commented [include/test/test_functions.bash http://nst.svn.sourceforge.net/viewvc/nst/trunk/test/include/test_functions.bash?revision=HEAD&view=markup] file.
	; src/scripts/getipv6/getipv6.sh		; src/scripts/getipv6/getipv6.sh
	: This is where you put the ''meat'' of your script. It will be adjusted to source in some common bash function files from the ''/usr/share/nst-bash/'' directory based on the ''INCLUDES'' setting in the ''makefile''.		: This is where you put the ''meat'' of your script. It will be adjusted to source in some common bash function files from the ''/usr/share/nst-bash/'' directory based on the ''INCLUDES'' setting in the ''makefile''.

Paul Blankenbaker: /* Updating Links/Menu Entries */

2011-03-03T22:12:17Z

Updating Links/Menu Entries

← Older revision		Revision as of 18:12, 3 March 2011
Line 136:		Line 136:

	= Updating Links/Menu Entries =		= Updating Links/Menu Entries =

			Unfortunately, the ''nstnewscript'' does not automatically add links or menu entries for your new script into the files used to generate the NST WUI and NST web site HTML. You will need to edit the following files:

			; src/scripts/nstmenu/share/applications/nstwui.documents.apps.xml
			: A file which contains many menu item definitions for the NST WUI (including NST scripts).
			; src/scripts/nstmenu/share/applications/website.apps.xml
			: A file which contains many menu item definitions for the NST web site (including NST scripts).
			; src/scripts/nstmenu/share/groups/website.nstscripts.group.xml
			: The menu panel for the NST web site which lists the NST scripts.
			; src/scripts/nstmenu/share/groups/documents.nstscripts.group.xml
			: The menu panel for the NST WUI which lists the NST scripts.
			; wui/index.cgi
			: The main index page of the NST WUI which has a list of NST script links.

Paul Blankenbaker: /* Files You Should Edit */

2011-03-03T22:04:33Z

Files You Should Edit

@@ Line 120: / Line 120: @@
 ; yum/pkgs/nst-getipv6/template.spec
 : This file will need to be updated (at a minimum you will want to edit the ''%description'' area). This is the template file that is used to generate the final spec file during the packaging stage of your script.
 = Updating Links/Menu Entries =