doctoolchain/doctoolchain.github.io

just for a redirect to the right docs page. Maybe we can turn this into a landing page later on

doctoolchain.github.io's Issues

dtcw effectively not running in non-interactive mode

Looks like dtcw is maintained here (why? I am always confused ;-)).

Cf. docToolchain/docToolchain#867 for the bug report.

Tutorial to use doctoolchain Jenkins image

wrapper causes problems in powershell when username has a space

REVIEW:

doctoolchain.github.io/dtcw.bat

Lines 139 to 144 in 7535386

	>> TODO REVIEW:
	you need docToolchain as CLI-Tool installed or docker."
	'@
	exit 1
	}

---

This issue was generated by todo based on a TODO comment in 7535386. It's been assigned to @rdmueller because they committed the code.

the wrapper stops if no java installed but you want to use docker

check wget version

it seems that older versions of wget have problems with SSL:

OpenSSL: error:1407742E:SSL routines:SSL23_GET_SERVER_HELLO:tlsv1 alert protocol version
Unable to establish SSL connection.

https://stackoverflow.com/questions/30817876/wget-ssl-alert-handshake-failure

the wrapper should test the version and print some error message when it detects an old version

gradle daemon has memory problems

we should add --no-daemon

Docker command call fails if docker installation path contains spaces

Docker can also be installed in directories, that contain spaces.
This is not likely on linux/wsl, but as #21 adds support for cygwin/msys2 (used in git bash), the path for docker on Windows is by default /c/Program Files/Docker/Docker/resources/bin/docker (from git bash's perspective), which leads to error:

bash: /c/Program: No such file or directory

when e.g. ./dtcw tasks --group=doctoolchain is executed in git bash.

Possible fix is in PR #22

problem with spaces in project folder name

does powershell need permission to execute the wrapper?

solution would be

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned

Review next line:

doctoolchain.github.io/dtcw.bat

Lines 122 to 127 in 7535386

	# TODO: Review next line:
	$command = "$docker_cmd run -u $(id -u):$(id -g) --name doctoolchain${dockerVersion} -e DTC_HEADLESS=1 -e DTC_SITETHEME -p 8042:8042 --rm -it --entrypoint /bin/bash -v ${PWD}:/project 'rdmueller/doctoolchain:v$dockerVersion' -c ""doctoolchain . $commandArgs $DTC_OPTS && exit"""
	}
	else {
	Write-Host "docToolchain not installed."

---

This issue was generated by todo based on a TODO comment in 7535386. It's been assigned to @rdmueller because they committed the code.

interactive mode for docker is a problem and not needed

Non default JAVA_HOME makes wrapper fail

If java is not on a default path (as set by /etc/default/login or other means), the wrapper fails since the executable cannot be found when doctoolchain is finally called.

The reason for this is the call to bash with the -l flag in line 37:

doctoolchain.github.io/dtcw

Line 237 in 068e50e

bash -cl "$command"

This causes bash to work as login shell and reset any environment variables to their login defaults.

check for correct version when local install

docToolchain wrapper is unable to find docker image for rc14

Describe the bug
The wrapper is unable to find docker image for [rc14.]

Expected behavior
Find docker image and use the docker installation.

Screenshots

Configuration

• OS: Apple

Check what's the best local installation directory in Win:

doctoolchain.github.io/dtcw.bat

Lines 19 to 24 in 7535386

	# TODO: Check what's the best local installation directory in Win:
	$home_path = $env:USERPROFILE
	$folder_name = ".doctoolchain"
	$dtcw_path = "$home_path\$folder_name"
	Write-Host "dtcw - docToolchain wrapper V0.18 (PS)"

---

This issue was generated by todo based on a TODO comment in 7535386. It's been assigned to @rdmueller because they committed the code.

dtcw.ps1 parsing and other errors

Hi!

I just tested docToolChain 2.0 with the new wrapper and found that it does not run ootb (dtcw - docToolchain wrapper V0.18 (PS)). A closing bracket is missing (no Docker is installed on my Windows system):

PS C:\Workspace\archdocu2> ./dtcw.ps1 generateHtml
At C:\Workspace\archdocu2\dtcw.ps1:116 char:6
+ else {
+      ~
Missing closing '}' in statement block or type definition.
    + CategoryInfo          : ParserError: (:) [], ParseException
    + FullyQualifiedErrorId : MissingEndCurlyBrace

After fixing this, I encountered the next problem:

Test-Path : Cannot bind argument to parameter 'Path' because it is null.
At C:\Workspace\archdocu2\dtcw.ps1:121 char:23
+         if (Test-Path $FolderName) {
+                       ~~~~~~~~~~~
    + CategoryInfo          : InvalidData: (:) [Test-Path], ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationErrorNullNotAllowed,Microsoft.PowerShell.Commands.TestPathCom
   mand

I assumed that instead of if (Test-Path $FolderName), it needs to be if (Test-Path $home_path).
With this change, the download succeeds and the script is able to run.

some wget versions throw errors

Exception in thread "main" javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: unable to find valid certification path to requested target

Hide outputs ?

doctoolchain.github.io/dtcw.bat

Lines 131 to 136 in 7535386

	# TODO: Hide outputs ?
	New-Item -Path $home_path -Name $folder_name -ItemType "directory" | Out-Null
	Invoke-WebRequest $distribution_url -OutFile "$dtcw_path\source.zip"
	Expand-Archive -LiteralPath "$dtcw_path\source.zip" -DestinationPath "$dtcw_path\"
	# Remove-Item "$dtcw_path\source.zip" # << Remove .zip ?
	$command = "$dtcw_path\docToolchain-$version\bin\doctoolchain.bat . $commandArgs $DTC_OPTS"

---

This issue was generated by todo based on a TODO comment in 7535386. It's been assigned to @rdmueller because they committed the code.