Commit Graph

162 Commits

Author SHA1 Message Date
jeremystretch
e04f29ed49 Update features docs for v3.4 2022-11-16 09:11:03 -05:00
jeremystretch
3df5875a05 Clean up plugins documentation 2022-11-15 16:55:18 -05:00
jeremystretch
a2517a7ee7 Add missing model documentation 2022-11-15 10:50:26 -05:00
Jeremy Stretch
af1398c64f Closes #10851: New staging mechanism (#10890)
* WIP

* Convert checkout() context manager to a class

* Misc cleanup

* Drop unique constraint from Change model

* Extend staging tests

* Misc cleanup

* Incorporate M2M changes

* Don't cancel wipe out creation records when an object is deleted

* Rename Change to StagedChange

* Add documentation for change staging
2022-11-14 13:55:03 -05:00
Jeremy Stretch
68cf700a3e Closes #10560: New global search (#10676)
* Initial work on new search backend

* Clean up search backends

* Return only the most relevant result per object

* Clear any pre-existing cached entries on cache()

* #6003: Implement global search functionality for custom field values

* Tweak field weights & document guidance

* Extend search() to accept a lookup type

* Move get_registry() out of SearchBackend

* Enforce object permissions when returning search results

* Add indexers for remaining models

* Avoid calling remove() on non-cacheable objects

* Use new search backend by default

* Extend search backend to filter by object type

* Clean up search view form

* Enable specifying lookup logic

* Add indexes for value field

* Remove object type selector from search bar

* Introduce SearchTable and enable HTMX for results

* Enable pagination

* Remove legacy search backend

* Cleanup

* Use a UUID for CachedValue primary key

* Refactoring search methods

* Define max search results limit

* Extend reindex command to support specifying particular models

* Add clear() and size to SearchBackend

* Optimize bulk caching performance

* Highlight matched portion of field value

* Performance improvements for reindexing

* Started on search tests

* Cleanup & docs

* Documentation updates

* Clean up SearchIndex

* Flatten search registry to register by app_label.model_name

* Clean up search backend classes

* Clean up RestrictedGenericForeignKey and RestrictedPrefetch

* Resolve migrations conflict
2022-10-21 13:16:16 -04:00
jeremystretch
a8ec25d635 Merge branch 'develop' into feature 2022-10-20 16:07:03 -04:00
Arthur Hanson
597578f5c3 10571 replace deprecated mkdoc settings (#10622)
* 10571 replace deprecated mkdoc settings

* Omit landing page from docs nav menu

Co-authored-by: jeremystretch <jstretch@ns1.com>
2022-10-12 08:36:02 -04:00
Arthur Hanson
f63ee79a35 8927 plugin search (#10489)
* #7016 base search classes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 7016 add search indexes

* 8927 refactor search

* 8927 refactor search

* 8927 refactor search

* 8927 refactor search

* 8927 get search choices working

* 8927 cleanup - optimize

* 8927 use backend search function

* 8927 fix for plugin search

* 8927 add docs

* Move search app to a module under netbox/

* Utilize global registry to register model search classes

* Build search form options from registry

* Determine search categories from model app by default

* Enable dynamic search registration for plugins

* Update docs & improve plugin support

* Clean up search backend class

* Docs for #8927

Co-authored-by: jeremystretch <jstretch@ns1.com>
2022-10-10 14:00:59 -04:00
jeremystretch
4a4fea40f5 Merge branch 'develop' into feature 2022-09-30 17:17:18 -04:00
jeremystretch
544d3bbbfb Fixes #10496: Use page.canonical_url to identify ReadTheDocs builds 2022-09-28 09:30:38 -04:00
jeremystretch
0bf0bf848f Closes #10314: Move clone() method from NetBoxModel to CloningMixin 2022-09-13 14:36:37 -04:00
jeremystretch
657404f1ab Initial draft of git cheat sheet 2022-08-26 16:52:00 -04:00
jeremystretch
b680b4f65f Add model documentation for JournalEntry 2022-08-16 16:06:48 -04:00
jeremystretch
a47b1c571c Add feature docs for virtualization 2022-08-12 14:11:58 -04:00
jeremystretch
00098ac3ff Merge branch 'feature' into docs-refresh 2022-08-12 10:19:38 -04:00
jeremystretch
2b25f7cea7 Closes #9994: Disable search indexing for local documentation builds 2022-08-12 09:21:28 -04:00
jeremystretch
3dd429424a Finish features documentation 2022-08-11 15:29:26 -04:00
jeremystretch
3e77e6520c Restore model documentation for all models under extras 2022-08-11 11:37:07 -04:00
jeremystretch
8b5771a73d Continued work on feature docs 2022-08-10 14:07:51 -04:00
jeremystretch
20b0b76dbf Continued work on feature docs 2022-08-10 12:51:21 -04:00
jeremystretch
d7685184d0 Drop markdown-include 2022-08-04 14:12:51 -04:00
jeremystretch
4b987453fd Reorganize documentation 2022-08-04 14:11:52 -04:00
jeremystretch
522a4940aa Add mermaid flowcharts showing rough data model dependencies 2022-07-29 16:23:45 -04:00
jeremystretch
31c2cd8301 Reorganize configuration docs 2022-07-29 15:10:50 -04:00
jeremystretch
c77363f7e4 Started "getting started" guide 2022-07-29 13:45:59 -04:00
jeremystretch
88266a4ddf Move data model definitions to separate hierarchy 2022-07-29 10:30:47 -04:00
jeremystretch
31ebe33558 Rearrange introductory content 2022-07-29 10:06:26 -04:00
jeremystretch
81761aa177 Release v3.3-beta1 2022-07-14 12:04:53 -04:00
jeremystretch
6f95a14a0b Documentation cleanup 2022-07-11 17:29:25 -04:00
jeremystretch
77168de155 Closes #9075: Introduce AbortRequest exception for cleanly interrupting object mutations 2022-06-30 15:15:07 -04:00
kkthxbye-code
3608a3d430 Move markdown documentation to docs 2022-06-16 22:26:37 +02:00
jeremystretch
7a1048d86a #9340: Introduce config parameters for Sentry sampling rates 2022-05-12 10:00:57 -04:00
jeremystretch
2f57e2eac4 Enable & document Sentry integration 2022-05-11 14:13:50 -04:00
jeremystretch
01fccfc60f Closes #9218: Update documentation links with docs.netbox.dev 2022-04-25 09:48:39 -04:00
jeremystretch
16f60ea5ff Closes #9137: Add SSO configuration guide for Okta 2022-04-15 16:03:36 -04:00
jeremystretch
4979d1c9b6 Closes #9136: Add SSO configuration guide for Microsoft Azure AD 2022-04-14 21:42:47 -04:00
jeremystretch
b454583848 Restore documentation search function 2022-04-14 14:24:34 -04:00
jeremystretch
454e6c9675 Revise plugins documentation 2022-03-08 15:44:35 -05:00
jeremystretch
7573dde28f Merge v3.1.9 2022-03-07 10:55:30 -05:00
jeremystretch
89f4d1c59f Support the direct use of TagFilter 2022-03-02 12:06:07 -05:00
Jason Yates
9c96654008 Updating mkdocs to automatically adjust theme
Automatically adjusts documentation theme between default/slate based on users preference for dark mode.
2022-03-02 08:45:22 +00:00
jeremystretch
a8ee0f1e4d Merge branch 'develop' into feature 2022-02-25 14:06:45 -05:00
jeremystretch
3d53d72614 Fixes #8674: Fix rendering of tabbed content in documentation 2022-02-16 16:21:32 -05:00
jeremystretch
3f44aaa8fe Create custom RTD configuration 2022-02-11 14:49:45 -05:00
jeremystretch
5c1c021f3e Fix mkdocs requirements specification 2022-02-11 14:43:43 -05:00
jeremystretch
b83047fd34 Use project requirements to build docs 2022-02-11 14:36:03 -05:00
jeremystretch
aafadd81ec Update documentation for v3.2 2022-02-11 12:57:08 -05:00
jeremystretch
f9894e7688 Document templates supported for plugin use 2022-02-08 12:14:37 -05:00
jeremystretch
41b804d350 Initial work on GraphQL 2022-02-04 15:06:58 -05:00
jeremystretch
ab6f19cf0c Establish 4 core forms in netbox.forms.base 2022-01-28 15:48:15 -05:00