New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[WIP] Describe "System Configuration" fields - draft #4830
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is great @StackScribe, thanks so much for putting this together!
I went through and made a couple of small formatting/syntax suggestions, but nothing overly crucial. I also suggested removing the unnecessary text as it does not need to be part of the document any more.
Use the *Manage Jenkins >> System Configuration* page to configure | ||
many standard aspects of your Jenkins server, including: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the *Manage Jenkins >> System Configuration* page to configure | |
many standard aspects of your Jenkins server, including: | |
Use the *Manage Jenkins >> System Configuration* page to configure many standard aspects of your Jenkins server, including: |
full stop for each sentence (1 per line) makes it easier to review
See link:http://localhost:4242/doc/book/managing/casc/[Configuration as Code] | ||
for more information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See link:http://localhost:4242/doc/book/managing/casc/[Configuration as Code] | |
for more information. | |
Refer to link:http://localhost:4242/doc/book/managing/casc/[Configuration as Code] for more information. |
update syntax/full stop per line
The top of the System Configuration page | ||
sets basic information about the controller: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The top of the System Configuration page | |
sets basic information about the controller: | |
The top of the System Configuration page sets basic information about the controller: |
same as above, full stop per line
* *Home Directory* -- Display the location of the Jenkins home directory. | ||
You can change this location | ||
by modifying the value of the `JENKINS_HOME` environment variable. | ||
|
||
* *System Message* -- Text that is displayed | ||
at the top of your Jenkins home page. | ||
Use this page to display the name of the server | ||
and a short description of its purpose. | ||
It is also used to display announcements about scheduled down time | ||
and other information of interest to all Jenkins users. | ||
This field can include HTML tags | ||
or a pointer to a Wiki page and information about who to contact. | ||
|
||
Inline help is available for most fields on most *Manage Jenkins* pages. | ||
To access the help, select the *?* icon to the right of each field. | ||
Click the *?* icon again to hide the help text. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* *Home Directory* -- Display the location of the Jenkins home directory. | |
You can change this location | |
by modifying the value of the `JENKINS_HOME` environment variable. | |
* *System Message* -- Text that is displayed | |
at the top of your Jenkins home page. | |
Use this page to display the name of the server | |
and a short description of its purpose. | |
It is also used to display announcements about scheduled down time | |
and other information of interest to all Jenkins users. | |
This field can include HTML tags | |
or a pointer to a Wiki page and information about who to contact. | |
Inline help is available for most fields on most *Manage Jenkins* pages. | |
To access the help, select the *?* icon to the right of each field. | |
Click the *?* icon again to hide the help text. | |
* *Home Directory* - Display the location of the Jenkins home directory. | |
** You can change this location by modifying the value of the `JENKINS_HOME` environment variable. | |
* *System Message* - Text that is displayed at the top of your Jenkins home page. | |
** Use this page to display the name of the server and a short description of its purpose. | |
It is also used to display announcements about scheduled down time and other information of interest to all Jenkins users. | |
This field can include HTML tags or a pointer to a Wiki page and information about who to contact. | |
Inline help is available for most fields on most *Manage Jenkins* pages. | |
To access the help, select the *?* icon to the right of each field name. | |
Select the *?* icon again to hide the help text. |
update some syntax/formatting (full stops)
//// | ||
These fields no longer appear on the *System Configuration* page. | ||
== SCM tools | ||
|
||
This field configures tools on the controller itself; | ||
it does not control the tools that are configured in a build agent | ||
for running builds. | ||
|
||
Git is supported out-of-the-box. | ||
Plugin support is provided for | ||
Subversion, Mercurial, Perforce, Team Foundation Server, and other SCMs. | ||
In most cases, the plugin for the tool must be installed separately | ||
before you configure the tool on the System Configuration page. | ||
|
||
== SCM and authentication | ||
|
||
Most SCM tools support or require authentication when talking to servers. | ||
Different SCMs are configured differently, | ||
but most (including Git, SVN, Mercurial, and Team Foundation Server) | ||
use the Credentials plugin. | ||
However, Perforce requires that each project | ||
enters credentials separately. | ||
//// |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
//// | |
These fields no longer appear on the *System Configuration* page. | |
== SCM tools | |
This field configures tools on the controller itself; | |
it does not control the tools that are configured in a build agent | |
for running builds. | |
Git is supported out-of-the-box. | |
Plugin support is provided for | |
Subversion, Mercurial, Perforce, Team Foundation Server, and other SCMs. | |
In most cases, the plugin for the tool must be installed separately | |
before you configure the tool on the System Configuration page. | |
== SCM and authentication | |
Most SCM tools support or require authentication when talking to servers. | |
Different SCMs are configured differently, | |
but most (including Git, SVN, Mercurial, and Team Foundation Server) | |
use the Credentials plugin. | |
However, Perforce requires that each project | |
enters credentials separately. | |
//// |
remove text if these are no longer displayed
* *System Admin e-mail address* -- Define the email address to which email | ||
about general Jenkins issues are sent. | ||
This can be an individual's email address | ||
or an email alias that contains multiple email addresses. | ||
|
||
== Timestamper | ||
|
||
The **Timestamper** fields define the format used | ||
to display timestamp information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
* *System Admin e-mail address* -- Define the email address to which email | |
about general Jenkins issues are sent. | |
This can be an individual's email address | |
or an email alias that contains multiple email addresses. | |
== Timestamper | |
The **Timestamper** fields define the format used | |
to display timestamp information. | |
* *System Admin e-mail address* -- Define the email address to which email about general Jenkins issues are sent. | |
This can be an individual's email address or an email alias that contains multiple email addresses. | |
== Timestamper | |
The **Timestamper** fields define the format used to display timestamp information. |
small formatting suggestion
As you learn more about how Jenkins works and how your project uses Jenkins, | ||
you can modify the values of settings on this page. | ||
Use these settings to fine-tune the behavior of your Jenkins instance. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As you learn more about how Jenkins works and how your project uses Jenkins, | |
you can modify the values of settings on this page. | |
Use these settings to fine-tune the behavior of your Jenkins instance. | |
As you learn more about how Jenkins works and how your project uses Jenkins, you can modify the values of settings on this page. | |
Use these settings to fine-tune the behavior of your Jenkins instance. |
small formatting suggestion
When you are done modifying this screen, | ||
scroll to the bottom and click | ||
*Save* to apply your configuration changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you are done modifying this screen, | |
scroll to the bottom and click | |
*Save* to apply your configuration changes. | |
When you are done modifying this screen, scroll to the bottom and select *Save* to apply your configuration changes. |
small formatting and syntax suggestion
Select **Managment Options** to start, stop, and reload the Jenkins service. | ||
|
||
To reload the configuration from disk, | ||
Jenkins rereads the configuration from `$JENKINS_HOME` | ||
without restarting Jenkins. | ||
|
||
The **Prepare for Shutdown** option | ||
prevents new jobs from being started | ||
and waits for running jobs to complete. | ||
Use this option to ensure a clean job termination before you shut down or restart Jenkins. | ||
|
||
The Management page provides Jenkins Upgrade management. | ||
If you are running a standalone server, | ||
you can perform a one-click upgrade. | ||
Otherwise, you have a direct link to the latest WAR. | ||
|
||
**Manage Old Data** helps to handle dropped configuration items after an upgrade. | ||
|
||
//// | ||
== What did we learn? | ||
//// |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Select **Managment Options** to start, stop, and reload the Jenkins service. | |
To reload the configuration from disk, | |
Jenkins rereads the configuration from `$JENKINS_HOME` | |
without restarting Jenkins. | |
The **Prepare for Shutdown** option | |
prevents new jobs from being started | |
and waits for running jobs to complete. | |
Use this option to ensure a clean job termination before you shut down or restart Jenkins. | |
The Management page provides Jenkins Upgrade management. | |
If you are running a standalone server, | |
you can perform a one-click upgrade. | |
Otherwise, you have a direct link to the latest WAR. | |
**Manage Old Data** helps to handle dropped configuration items after an upgrade. | |
//// | |
== What did we learn? | |
//// | |
Select **Managment Options** to start, stop, and reload the Jenkins service. | |
To reload the configuration from disk, | |
Jenkins rereads the configuration from `$JENKINS_HOME` | |
without restarting Jenkins. | |
The *Prepare for Shutdown* option prevents new jobs from being started, and waits for running jobs to complete. | |
Use this option to ensure a clean job termination before you shut down or restart Jenkins. | |
The Management page provides Jenkins Upgrade management. | |
If you are running a standalone server, you can perform a one-click upgrade. | |
Otherwise, you have a direct link to the latest WAR. | |
*Manage Old Data* helps to handle dropped configuration items after an upgrade. |
small formatting and syntax suggestion, remove unneeded text
Use the *Manage Jenkins >> Global Tool Configuration* page | ||
to configure the tools that Pipeline developers can use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use the *Manage Jenkins >> Global Tool Configuration* page | |
to configure the tools that Pipeline developers can use. | |
Use the *Manage Jenkins >> Global Tool Configuration* page to configure the tools that Pipeline developers can use. |
small formatting suggestion
Please take a moment and address the merge conflicts of your pull request. Thanks! |
No description provided.