11 Commits

Author SHA1 Message Date
Marian Harbach
ebeb15460c Enabling linkattrs explicitly on doc pages having external links
Asciidoc may fail to render link attributes for external links
supposed to open in a new window correctly. This change adds
:linkattrs: to the beginning of such files to force parsing link
attributes correctly.

Bug: Issue 12068
Change-Id: If18be60de646ff78f672239dd4fa435fd4fd92ab
2019-12-13 10:59:57 +00:00
Marian Harbach
34253376e6 Make all external links in the documentation open in a new window
To make it easier to stay on track when reading documentation, I
added ",role=external,window=_blank" to all links in the
documentation directory that were not pointing at another piece of documentation.

Change-Id: I94bf254c90f8ebce067c765be0a2932b755a045a
2019-12-10 22:54:40 +01:00
Gert van Dijk
dc4f8d1723 Documentation: Also consider the use of kerberos authentication over SSH
Most documentation assumed the use of SSH public key authentication. This
change removes that assumption and adds some hints on client configuration
with OpenSSH and kerberos.

Change-Id: I4d5654a088a68afd740d3e4e91eaf15d0bbf58b1
2017-08-28 01:44:52 +02:00
Hugo Arès
93ef427306 Revert "Add '-T' switch to the SSH connectivity check examples"
This commit was needed because of the regression introduced in SSHD used
with MINA backend. SSHD version 1.2.0 fixed that regression so this
change is no longer needed.

This reverts commit 7ee677b9d3ca15b0a19850b47680c37e1977ec4b.

Change-Id: I90dc2889c601083a312f643c52b2dcf6a59ab2b6
2016-04-05 18:22:09 +00:00
Saša Živkov
7ee677b9d3 Add '-T' switch to the SSH connectivity check examples
Since the upgrade of apache mina in If047c3a279fc9c98a59ac3102b0db3f5f2fdae48
the SSH connectivity check which we recommend in our documentation
didn't work:

$ ssh admin@localhost -p29418
Bad packet length 1184572426.
ssh_dispatch_run_fatal: Connection to ::1: message authentication code incorrect

I could reproduce this error from both OSX and Linux. Using the -T option
fixes the issue.

This issue only affected the SSH connectivity check. All SSH commands
work without the -T swith and git-over-http also works.

Change-Id: I97148b2700ad9927b4e96a38dcbf7243f7f53ead
2016-01-29 14:00:52 +01:00
David Pursehouse
a1d633bb22 Doc: Consistently refer to "Web UI" rather than "WebUI"
Change-Id: Ia41e162394fa0f9ab9ae05c16db0c3032fde19cf
2014-05-02 17:21:22 +09:00
Yuxuan 'fishy' Wang
61698b14e0 Use the new section title style in Asciidoctor.
We previous use the section title style like:

Section level 1
===============

Section level 2
---------------

Which have a problem in Asciidoctor that the number of "="s or "-"s must match
the number of characters in the header exactly, as a result it's easy to make
mistakes while changing the titles. Asciidoctor provides a better style like:

= Section level 1

== Section level 2

So we switched to this style.

Also fixed a bug in replace_macros.py, which will not cause any problem in the
old style.

Change-Id: I811dd7238735d98f662767c17086152cd69aea02
2013-12-20 12:55:51 -08:00
Yuxuan 'fishy' Wang
99cb68dec4 Added searchbox to documentation.
This provides the entry point of the documentation search feature.

Change-Id: Iea2b707995c0e042829db509927384dcec7aaf43
2013-11-05 12:49:43 -08:00
David Pursehouse
221d4f6250 Documentation: Various corrections
Correct typos, spelling mistakes, and grammatical errors.

Change-Id: I80ec66de7b2228f9ff45a2f06faf576707195758
2012-06-12 14:54:54 +02:00
Edwin Kempin
ddfc41abb1 Fix formatting issues in error documentation
Most of the bulleted and numbered list in the error documentation
were incorrectly formatted.

Change-Id: Ib3ef44427c97dd8ed68b28414d477df372330a54
Signed-off-by: Edwin Kempin <edwin.kempin@sap.com>
2011-05-06 10:32:05 +02:00
Edwin Kempin
014de30871 Added explanation for "Permission denied" error
Added a documentation page that explains the
"Permission denied (publickey)" error in details
and what can be done to solve the problem.

Signed-off-by: Edwin Kempin <edwin.kempin@gmail.com>
Change-Id: I790a22e8c451bb1adc031cc24a077b7e9ccbf9c4
2011-01-12 11:03:43 +01:00