Skip to content

Add core engine section in docs and rename example directories #71

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

Merged
merged 22 commits into from
Oct 19, 2021

Conversation

dgarros
Copy link
Contributor

@dgarros dgarros commented Oct 11, 2021

Fixes #56 & #54

This PR is focusing on the documentation and is primarily :

  • Adding a new Core Engine section to cover how to work with the flags and how to provide a custom Diff class
  • Improving the integration of the examples with the documentation. In the process the directories of the examples have been renamed to be more explicit

This PR is based on #53 and shouldn't be merged before #53 has been merged

Comment on lines +6 to +7
.. mdinclude:: 01-flags.md
.. mdinclude:: 02-customize-diff-class.md
Copy link
Collaborator

Choose a reason for hiding this comment

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

Not a huge fan of mixing-and-matching Markdown and ReST in the same docs. Which one is our standard for newly created documentation files?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think we have it clearly defined yet, I'll open a new issue to track that

dgarros and others added 7 commits October 15, 2021 13:08
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros dgarros requested a review from glennmatthews October 18, 2021 13:08
dgarros and others added 13 commits October 18, 2021 10:22
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros dgarros merged commit f17b2f5 into dga-examples-nautobot Oct 19, 2021
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

Successfully merging this pull request may close these issues.

2 participants