redhat-documentation / modular-docs

Modular Documentation Project provides guidelines and examples for writing technical documentation using a modular framework.
Creative Commons Attribution Share Alike 4.0 International
82 stars 68 forks source link

Explicitly forbid including modules in other modules #99

Closed tradej closed 3 years ago

tradej commented 5 years ago

The documentation currently does not contain an explicit note that modules may not directly include:: other modules (i. e. only assemblies can do that). This has come up a few times, so I believe it warrants and explicit mention somewhere, e. g. in the module definition.

theashiot commented 3 years ago

Hi @tradej, @emmurphy1,

I've identified the following places where we can add a line stating modules can not include other modules:

https://redhat-documentation.github.io/modular-docs/#what-modular-documentation-is After the sentence "An assembly can also include other assemblies", we can have a line "Modules can not include other modules".

https://redhat-documentation.github.io/modular-docs/#_creating_modules We can have an admonition here stating modules can not include other modules.

What do you think?

best,

ashwin

tradej commented 3 years ago

Thank you @theashiot, I believe both places are suitable.

emmurphy1 commented 3 years ago

https://github.com/redhat-documentation/modular-docs/pull/161

thatdocslady commented 3 years ago

161

Looks like this PR fixed the issue, recommending to close.

emmurphy1 commented 3 years ago

Yes, thanks @thatdocslady.