Skip to content

Updated doc for default connection mode - #7011

Merged
kmartens27 merged 3 commits into
jenkins-infra:masterfrom
Harishrao13:master
Jan 16, 2024
Merged

Updated doc for default connection mode#7011
kmartens27 merged 3 commits into
jenkins-infra:masterfrom
Harishrao13:master

Conversation

@Harishrao13

Copy link
Copy Markdown
Contributor

Closes #6986

@Harishrao13
Harishrao13 requested a review from a team as a code owner January 15, 2024 10:35
@probot-autolabeler probot-autolabeler Bot added the documentation Jenkins documentation, including user and developer docs, solution pages, etc. label Jan 15, 2024

@kmartens27 kmartens27 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

everything looks okay to me from a docs persepctive, thanks very much @Harishrao13.

In the future, make sure that you are submitting pull requests from a new branch in your forked repo. The Jenkins contributing guide outlines the proper steps to take when creating pull requests to Jenkins.io, which includes creating a new branch for any work you want to perform. This also avoids updating the master branch, which can cause issues if it is not aligned with the upstream repository.

Comment thread content/doc/book/managing/cli.adoc Outdated
Comment on lines +228 to +229
The advantage is that a more standard transport is used,
avoiding problems with many reverse proxies or the need for special proxy configuration.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The advantage is that a more standard transport is used,
avoiding problems with many reverse proxies or the need for special proxy configuration.
The advantage is that a more standard transport is used, avoiding problems with many reverse proxies or the need for special proxy configuration.

Suggestion to combine lines for full sentence

Comment thread content/doc/book/managing/cli.adoc Outdated
==== HTTP connection mode

This is the default mode, though you may pass the `-http` option explicitly for clarity.
Starting from Jenkins 2.391, the default mode is `-webSocket`. To use the HTTP mode, you must explicitly pass the `-http` option.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Starting from Jenkins 2.391, the default mode is `-webSocket`. To use the HTTP mode, you must explicitly pass the `-http` option.
Starting from Jenkins 2.391, the default mode is `-webSocket`.
To use the HTTP mode, you must explicitly pass the `-http` option.

Separating out full sentences

@Harishrao13

Copy link
Copy Markdown
Contributor Author

Sorry, I will follow the guidelines next time

@kmartens27

Copy link
Copy Markdown
Contributor

@Harishrao13 no worries at all! I hope this is more educational than anything else.

I just wanted to point this out so that you have an easier, and hopefully headache-free experience going forward. Since the "master" or "main" branch should be the absolute truth of the repository, it is best practice to use a branch to perform any changes or work. This keeps the original information in tact, without threat of anything being changed or lost inadvertently.

@jglick jglick left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kmartens27
kmartens27 merged commit 0f8942f into jenkins-infra:master Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Jenkins documentation, including user and developer docs, solution pages, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

WebSocket CLI mode is the default now

3 participants