Overhaul docs #468
Open
Overhaul docs #468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
Kircheneer
commented
Jun 12, 2024
Kircheneer
commented
- Start implementing some of the Diataxis Framework
- Overhaul the developing jobs tutorial to make it more tutorial-ly
- Fix a significant bug that never allowed jobs to run in non-dry-run mode
Kircheneer
force-pushed
the
lk-docs-update
branch
3 times, most recently
from
979d095 to
c4fd5ac
Compare
Kircheneer
force-pushed
the
lk-docs-update
branch
4 times, most recently
from
7b65b20 to
ff8a9ce
Compare
jdrew82
requested changes
Nov 21, 2024
docs/dev/jobs.md
Outdated
|
|
||
| !!! note | ||
| You still want your models to adhere to the [modeling guide](../user/modeling.md), since it provides you the auto-generated `load` function for the diffsync adapter on the Nautobot side. | ||
| At this point, the job will show up in the web GUI, and you can enable it and even run it! You should see the objects you specified in the remote adapter being synchronized into Nautobot now. Also take a look at the "SSoT Sync Details" button in the top right of the job result page to get some more information on what diffsync is doing. |
There was a problem hiding this comment.
Suggested change
| At this point, the job will show up in the web GUI, and you can enable it and even run it! You should see the objects you specified in the remote adapter being synchronized into Nautobot now. Also take a look at the "SSoT Sync Details" button in the top right of the job result page to get some more information on what diffsync is doing. | |
| At this point, the Job will show up in the web GUI, at which point you can enable it and even run it! You should see the objects you specified in the remote Adapter being synchronized into Nautobot now. In addition, clicking on the "SSoT Sync Details" button in the top right of the Job result page provides additional information on what DiffSync is doing during the synchronization process. |
|
|
||
| !!! warning | ||
| Special care should be taken when synchronizing new Devices with children Interfaces into a Nautobot instance that also defines Device Types with Interface components of the same name. When the new Device is created in Nautobot, its Interfaces will also be created as defined in the respective Device Type. As a result, when SSoT will attempt to create the children Interfaces loaded by the remote adapter, these will already exist in the target Nautobot system. In this scenario, if not properly handled, the sync will fail! Possible remediation steps may vary depending on the specific use-case, therefore this is left as an exercise to the reader/developer to solve for their specific context. | ||
| The above example shows the simplest field type (an attribute on the model), however, to build a production implementation you will need to understand how to identify different variants of fields by following the [modeling docs](../dev/modeling.md). |
There was a problem hiding this comment.
Suggested change
| The above example shows the simplest field type (an attribute on the model), however, to build a production implementation you will need to understand how to identify different variants of fields by following the [modeling docs](../dev/modeling.md). | |
| The above example shows the simplest field type (an attribute on the model), however, to build a production implementation you will need to understand how to identify different variants of fields by following the [Modeling docs](../dev/modeling.md). |
This was referenced Dec 12, 2024
Co-authored-by: Justin Drew <2396364+jdrew82@users.noreply.github.com>
Co-authored-by: Justin Drew <2396364+jdrew82@users.noreply.github.com>
Kircheneer
force-pushed
the
lk-docs-update
branch
from
50aeaf5 to
5ec4166
Compare
Co-authored-by: Justin Drew <2396364+jdrew82@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.