Skip to content

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

Merged
dgarros merged 22 commits into
dga-examples-nautobotfrom
dga-update-doc
Oct 19, 2021
Merged

Add core engine section in docs and rename example directories#71
dgarros merged 22 commits into
dga-examples-nautobotfrom
dga-update-doc

Conversation

@dgarros

@dgarrosdgarros commented Oct 11, 2021

Copy link
Copy Markdown
Contributor

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

glennmatthews
glennmatthews reviewed Oct 12, 2021
View reviewed changes
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/02-customize-diff-class.md Outdated
Comment threaddocs/source/core_engine/02-customize-diff-class.md Outdated
Comment threaddocs/source/core_engine/02-customize-diff-class.md Outdated
Comment threaddocs/source/core_engine/index.rst
Comment on lines +6 to +7
.. mdinclude:: 01-flags.md
.. mdinclude:: 02-customize-diff-class.md

@glennmatthewsglennmatthewsOct 12, 2021

Copy link
Copy Markdown
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?

@dgarrosdgarrosOct 15, 2021

Copy link
Copy Markdown
ContributorAuthor

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

Comment threaddocs/source/examples/index.rst
Comment threadexamples/02-callback-function/example2.py
dgarrosand others added 7 commits October 15, 2021 13:08
@dgarros
Merge pull request#53from networktocode/dga-examples-nautobot
04890dc
Add new example with pynautobot
@dgarros
Add core engine section in docs and rename example directories
b2d92db
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
6ef651c
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/02-customize-diff-class.md
93e36b4
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
4b76360
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/02-customize-diff-class.md
827cefc
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros
Fix example directory names in unit tests
f29a4fd
glennmatthews
glennmatthews reviewed Oct 18, 2021
View reviewed changes
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/01-flags.md Outdated
Comment threaddocs/source/core_engine/02-customize-diff-class.md Outdated
Comment threaddocs/source/core_engine/02-customize-diff-class.md Outdated
Comment threaddocs/source/examples/index.rst Outdated
Comment threaddocs/source/examples/index.rst
Comment threaddocs/source/examples/index.rst
dgarrosand others added 13 commits October 18, 2021 10:22
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
54f6b3b
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
6b13497
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
d2bbd57
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/02-customize-diff-class.md
54839fe
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
c28f405
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
503a751
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros
Remove Change the rendering of the result of the diff section from doc
6e38ea1
@dgarros
Convert link to ReST format
aa88e88
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
6591f73
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
a8e22a1
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
066f742
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros@glennmatthews
Update docs/source/core_engine/01-flags.md
1566714
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
@dgarros
Feedback from glenn
8d937cc
@dgarros
dgarros merged commit f17b2f5 into dga-examples-nautobotOct 19, 2021
@dgarros
dgarros deleted the dga-update-doc branch October 19, 2021 14:42
@dgarrosdgarros mentioned this pull request Oct 19, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@glennmatthewsglennmatthewsglennmatthews approved these changes
@josh-silvasjosh-silvasAwaiting requested review from josh-silvas

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@dgarros@glennmatthews