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

Document more clearly which files the process-asciidoc goal choses to process #549

Open
mojavelinux opened this issue Jul 26, 2021 · 2 comments

Comments

@mojavelinux
Copy link
Member

Category: Documentation enhancement

The main purpose of the process-asciidoc goal is to find and convert AsciiDoc files. However, it's not immediately clear, especially to new users, which files the goal selects. This information is tucked away in an admonition block in the documentation for the sourceDirectory property. I think it would be better if this information were to be moved to either the preamble or a dedication section that follows it.

This new paragraph should explain that the goal will automatically discover AsciiDoc files that ends with .adoc (other extensions too?) in the specified sourceDirectory and convert them. It can then emphasize that the goal ignores files that are considered non-public, such as internal include files and hidden files. The reason these files are excluded is so that they can be put there to reference using the include directive without being converted separately.

@abelsromero
Copy link
Member

I am inclined to have a dedicated section under preamble, otherwise it's not very noticible, something like "Sources organization".

NOTE: I am not using "Source and resources organization" for shortness.

@mojavelinux
Copy link
Member Author

...or you could name it something like "File processing"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants