Comments (3)
andy-wm-arthur
commented on June 23, 2024
Comment Docs
User Documentation
- Common Workflows
- Restrictions to versioning
Developer Documentation
- Dolt overview
- Versioning Model
- Global state model
- Restrictions to model
Plugin Development Documentation
- Registering Versioned Models
from nautobot-app-version-control.
tim-fiola
commented on June 23, 2024
Expanding on @andrew-wm-arthur's initial thoughts on the doc structure, here are his thoughts with my additions:
Comment Documentation
User Documentation (@tim-fiola can write this)
- Concepts
- Branches
- Main (default name)
- Others
- Commits
- What is a commit?
- How do commits happen?
- When users modify anything in a branch
- Pull Requests
- Merges
- Conflicts
- Branches
- Common Workflows (@andrew-wm-arthur high level)
- Proposing a Change to the Data - Creating a branch, making changes, reviewing changes
- The Pull Request (PR) process
- Individual Commit Reversions
- Mass Reversions
- Roll back an entire merge
- Roll back an entire
- Restrictions to versioning (@andrew-wm-arthur)
Developer Documentation (@andrew-wm-arthur)
- Dolt overview
- Versioning Model
- Global state model
- Restrictions to model
- RESTful API Queries Against Branches (@tim-fiola can write this)
Plugin Development Documentation (@andrew-wm-arthur)
- Registering Versioned Models
from nautobot-app-version-control.
tim-fiola
commented on June 23, 2024
looking at this a bit, I may move some of Andy's docs from design.md to common_workflows.md, making design.md more technical, while adding the info common_workflows for a workflow-based approach
from nautobot-app-version-control.
Related Issues (20)
- Cannot switch Version Control from a non-main branch to main branch when Nautobot 1.2b is running HOT 2
- Error during installation mysql_config not found HOT 3
- Commits tab shows 'nautobot' as committer, even when a different user makes the commit HOT 2
- Commits Information Headers Case Needs Updating
- webhooks not saving the Object Type(s) upon initial webhook create
- Interface's vlan objects not include in diff
- In all URL and API paths, replace /dolt/ with /version-control/ HOT 1
- RFE: Require Peer Review for reverting commits
- RFE: Allow matching a dolt branch name to a git source branch name
- Handle/Document Migrations HOT 1
- Newer Dolt Versions Break Plugin HOT 11
- Epic: Version Control User Acceptance Testing Bug Bash
- POST to api/plugins/version-control/branches/ results in 500 HOT 1
- Revert currently doesn't handle conflicts
- Nautobot version supported
- Legacy templates need to extend `generic/object_detail.html`
- Support Newer Versions of Nautobot HOT 2
- dolt install.sh only supports installing dolt on x86_64 or x86 or Darwin-arm64 HOT 2
- Support Notes in UI
- Dolt issues with Nautobot v2 upgrade HOT 6
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from nautobot-app-version-control.