Skip to content
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

Http proxy #501

Merged
merged 7 commits into from
Nov 30, 2023
Merged

Http proxy #501

merged 7 commits into from
Nov 30, 2023

Conversation

EditKoselak
Copy link
Contributor

Description

Explain how to set HTTP proxy for the "dita" command

Motivation and Context

Fixes #189

How Has This Been Tested?

The documentation was compiled locally using the gradlew -PditaHome=/path/to/dita-ot command

Type of Changes

Documentation

Documentation and Compatibility

No additional documentation needed.

Checklist

Copy link
Member

@infotexture infotexture left a comment

Choose a reason for hiding this comment

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

The long line in this code block will require horizontal scrolling in HTML output, and be truncated in PDF output.

We may want to consider inserting \ line continuation characters in the code block to ensure the example remains readable, but I'm not sure if those can be encoded within the ANT_OPTS value in a way that works on all platforms. (Perhaps @raducoravu knows?) 🤔

parameters/dita-command-arguments.dita Outdated Show resolved Hide resolved
@infotexture
Copy link
Member

I'm also thinking we might want to move this information to a dedicated topic, perhaps in the Troubleshooting section, where other ANT_OPTS workarounds are described, but I can do that in a separate step.

@infotexture infotexture requested a review from raducoravu October 5, 2023 10:09
EditKoselak and others added 2 commits October 12, 2023 10:08
Co-authored-by: Roger Sheen <[email protected]>
Signed-off-by: EditKoselak <[email protected]>
@EditKoselak
Copy link
Contributor Author

EditKoselak commented Oct 12, 2023

The long line in this code block will require horizontal scrolling in HTML output, and be truncated in PDF output.

We may want to consider inserting \ line continuation characters in the code block to ensure the example remains readable, but I'm not sure if those can be encoded within the ANT_OPTS value in a way that works on all platforms. (Perhaps @raducoravu knows?) 🤔

Thank you for the suggestions! We tested the \ solution in bask and sh and it worked. We hope that this is OK on other platforms. Let us know if any further correction is needed.

Copy link
Member

@raducoravu raducoravu left a comment

Choose a reason for hiding this comment

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

Maybe instead of "for installing and downloading content" I would say "for installing plugins from the configured registry or processing remote referenced resources"

This part "provide the proxy configuration via the ANT_OPTS environment variable", on various operating systems there are various ways to set env variables, on Windows I would use in a Command Prompt window "set envName=envValue" and then I would call "dita..." on a separate line. On Mac OS I would use in the Terminal "export envName=envValue". I think this would be the same for Linux.
Also the "dita install " part should probably be on a separate line in the codeblock.

@EditKoselak
Copy link
Contributor Author

Hello @infotexture, @raducoravu,
thanks for the suggestions. Since adding extra info would make the note pretty complex, I think it would be better to move it to a separate section under Troubleshooting/Other error messages (Connection timed out), and create something similar to what we have in Increasing Java memory allocation.
We could keep a reference as a Tip in the original chapter (Arguments and options for the dita command).
What do you think?

@infotexture
Copy link
Member

@EditKoselak Yes, I think that's the right approach.

Copy link
Member

@infotexture infotexture left a comment

Choose a reason for hiding this comment

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

🙇 Thanks for your input here, looks pretty good now.

I implemented the feedback from @raducoravu in #501 (review) and prepared a few tweaks, but I'm not able to push additional commits to your fork as part of this PR, so I'll merge this as is now, and submit those separately.

@infotexture infotexture merged commit ea93f4f into dita-ot:develop Nov 30, 2023
4 checks passed
infotexture added a commit that referenced this pull request Nov 30, 2023
@infotexture infotexture added the enhancement Changes to an existing topic or feature label Nov 30, 2023
@infotexture infotexture mentioned this pull request Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Changes to an existing topic or feature
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Explain how to set HTTP proxy for the "dita" command
3 participants