Erroneous examples and other issues in 06-networks.md
otkd opened this issue · comments
What is the problem you're trying to solve
The Networks Top-Level Element documentation has specific issues including erroneous examples where volumes
is used instead of networks
, an incomplete ipam
example, and the absence of an internal
example.
Describe the solution you'd like
To improve the documentation, the following changes are suggested:
-
There are instances where the documentation refers to
volumes
instead ofnetworks
. These instances should be identified and corrected to ensure examples align with the context. -
The
ipam
example lacks some key details which can create confusion for users. The example should be revised to be more comprehensive and to better demonstrate how to useipam
in practice. -
The documentation currently lacks an example of how to create isolated networks with
internal
. This is a common use case and should be added to the documentation to help guide users through its implementation.
Additional context
Addressing these specific issues will greatly enhance the utility and clarity of the documentation, contributing to an overall better user experience.
Resolved by #388