Skip to content

Commit 87abbd8

Browse files
committed
initial drift manager conflict and cleanups to get jdiff drift managed
1 parent 1971a5e commit 87abbd8

File tree

118 files changed

+10647
-308
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

118 files changed

+10647
-308
lines changed

.cookiecutter.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,6 @@
1414
"project_with_config_settings": "no",
1515
"generate_docs": "yes",
1616
"version": "1.0.1",
17-
<<<<<<< HEAD
18-
"original_publish_year": "2022"
19-
=======
2017
"original_publish_year": "2022",
2118
"_drift_manager": {
2219
"template": "https://github.com/networktocode-llc/cookiecutter-ntc.git",
@@ -29,6 +26,5 @@
2926
"baked_commit_ref": "bc931311336d391d878202dba239389783ee9f09",
3027
"drift_managed_branch": "develop"
3128
}
32-
>>>>>>> 75750bd (Cookie updated targeting develop by NetworkToCode Cookie Drift Manager Tool)
3329
}
3430
}

README.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,7 @@
11
# Jdiff
22

3-
<!--
4-
Developer Note - Remove Me!
5-
6-
The README will have certain links/images broken until the PR is merged into `develop`. Update the GitHub links with whichever branch you're using (main etc.) if different.
7-
8-
The logo of the project is a placeholder (docs/images/icon-jdiff.png) - please replace it with your app icon, making sure it's at least 200x200px and has a transparent background!
9-
10-
To avoid extra work and temporary links, make sure that publishing docs (or merging a PR) is done at the same time as setting up the docs site on RTD, then test everything.
11-
-->
12-
133
<p align="center">
14-
<img src="https://raw.githubusercontent.com/networktocode/jdiff/develop/docs/images/icon-Jdiff.png" class="logo" height="200px">
4+
<img src="https://raw.githubusercontent.com/networktocode/jdiff/develop/docs/images/jdiff_logo.png" class="logo" height="200px">
155
<br>
166
<a href="https://github.com/networktocode/jdiff/actions"><img src="https://github.com/networktocode/jdiff/actions/workflows/ci.yml/badge.svg?branch=main"></a>
177
<a href="https://jdiff.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/jdiff/badge/"></a>
@@ -22,23 +12,23 @@ To avoid extra work and temporary links, make sure that publishing docs (or merg
2212

2313
## Overview
2414

25-
> Developer Note: Add a long (2-3 paragraphs) description of what the library does, what problems it solves, etc.
15+
`jdiff` is a lightweight Python library allowing you to examine structured data. `jdiff` provides an interface to intelligently compare JSON data objects and test for the presence (or absence) of keys. You can also examine and compare corresponding key-values.
2616

2717
## Documentation
2818

2919
Full documentation for this library can be found over on the [Jdiff Docs](https://jdiff.readthedocs.io/) website:
3020

31-
- [User Guide](https://jdiff.readthedocs.io/user/app_overview/) - Overview, Using the Library, Getting Started.
32-
- [Administrator Guide](https://jdiff.readthedocs.io/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the Library.
33-
- [Developer Guide](https://jdiff.readthedocs.io/dev/contributing/) - Extending the Library, Code Reference, Contribution Guide.
34-
- [Release Notes / Changelog](https://jdiff.readthedocs.io/admin/release_notes/).
35-
- [Frequently Asked Questions](https://jdiff.readthedocs.io/user/faq/).
21+
- [User Guide](https://jdiff.readthedocs.io/en/latest/user/lib_overview/) - Overview, Using the library, Getting Started.
22+
- [Administrator Guide](https://jdiff.readthedocs.io/en/latest/admin/install/) - How to Install, Configure, Upgrade, or Uninstall the library.
23+
- [Developer Guide](https://jdiff.readthedocs.io/en/latest/dev/contributing/) - Extending the library, Code Reference, Contribution Guide.
24+
- [Release Notes / Changelog](https://jdiff.readthedocs.io/en/latest/admin/release_notes/).
25+
- [Frequently Asked Questions](https://jdiff.readthedocs.io/en/latest/user/faq/).
3626

3727
### Contributing to the Documentation
3828

3929
You can find all the Markdown source for the App documentation under the [`docs`](https://github.com/networktocode/jdiff/tree/develop/docs) folder in this repository. For simple edits, a Markdown capable editor is sufficient: clone the repository and edit away.
4030

41-
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://jdiff/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
31+
If you need to view the fully-generated documentation site, you can build it with [MkDocs](https://www.mkdocs.org/). A container hosting the documentation can be started using the `invoke` commands (details in the [Development Environment Guide](https://jdiff.readthedocs.io/en/latest/dev/dev_environment/#docker-development-environment)) on [http://localhost:8001](http://localhost:8001). Using this container, as your changes to the documentation are saved, they will be automatically rebuilt and any pages currently being viewed will be reloaded in your browser.
4232

4333
Any PRs with fixes or improvements are very welcome!
4434

changes/+dne.documentation

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed the section headers for portions of the documentation.

changes/+main.housekeeping

Lines changed: 0 additions & 1 deletion
This file was deleted.

changes/.gitignore

Lines changed: 0 additions & 1 deletion
This file was deleted.

changes/.gitkeep

Whitespace-only changes.

changes/133.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix GitHub release failing in CI pipeline.

changes/134.added

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added documentation on the release checklist and process for the library.

changes/136.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix GitHub release failing in CI pipeline.

changes/140.fixed

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix invoke volume path.

0 commit comments

Comments
 (0)