Add documentation about adding the upgrade guide

Author: alamb

datafusion/core/src/lib.rs

@@ -1026,12 +1026,6 @@ doc_comment::doctest!(
     library_user_guide_adding_udfs
 );
 
-#[cfg(doctest)]
-doc_comment::doctest!(
-    "../../../docs/source/library-user-guide/api-health.md",
-    library_user_guide_api_health
-);
-
 #[cfg(doctest)]
 doc_comment::doctest!(
     "../../../docs/source/library-user-guide/building-logical-plans.md",
@@ -1103,3 +1097,9 @@ doc_comment::doctest!(
     "../../../docs/source/library-user-guide/upgrading.md",
     library_user_guide_upgrading
 );
+
+#[cfg(doctest)]
+doc_comment::doctest!(
+    "../../../docs/source/contributor-guide/api-health.md",
+    contributor_guide_api_health
+);

docs/source/library-user-guide/api-health.md renamed to docs/source/contributor-guide/api-health.md

@@ -26,6 +26,14 @@ breaking API changes, but they are sometimes necessary.
 When possible, rather than making breaking API changes, we prefer to deprecate
 APIs to give users time to adjust to the changes.
 
+## Upgrade Guides
+
+When making changes that require DataFusion users to make changes to their code
+as part of an upgrade please consider adding documentation to the version
+specific [Upgrade Guide]
+
+[upgrade guide]: ../library-user-guide/upgrading.md
+
 ## Breaking Changes
 
 In general, a function is part of the public API if it appears on the [docs.rs page]

docs/source/index.rst

@@ -132,7 +132,6 @@ To get started, see
    library-user-guide/extending-operators
    library-user-guide/profiling
    library-user-guide/query-optimizer
-   library-user-guide/api-health
    library-user-guide/upgrading
 
 .. .. _toc.contributor-guide:
@@ -146,6 +145,7 @@ To get started, see
    contributor-guide/development_environment
    contributor-guide/architecture
    contributor-guide/testing
+   contributor-guide/api-health
    contributor-guide/howtos
    contributor-guide/roadmap
    contributor-guide/governance