[GitHub] [airflow] rossturk commented on a diff in pull request #26217: Add automatically generated ERD schema for the MetaData DB

[GitBox <gi...@apache.org>]

rossturk commented on code in PR #26217:
URL: https://github.com/apache/airflow/pull/26217#discussion_r965357848


##########
docs/apache-airflow/database-erd-ref.rst:
##########
@@ -0,0 +1,23 @@
+ .. Licensed to the Apache Software Foundation (ASF) under one
+    or more contributor license agreements.  See the NOTICE file
+    distributed with this work for additional information
+    regarding copyright ownership.  The ASF licenses this file
+    to you under the Apache License, Version 2.0 (the
+    "License"); you may not use this file except in compliance
+    with the License.  You may obtain a copy of the License at
+
+ ..   http://www.apache.org/licenses/LICENSE-2.0
+
+ .. Unless required by applicable law or agreed to in writing,
+    software distributed under the License is distributed on an
+    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+    KIND, either express or implied.  See the License for the
+    specific language governing permissions and limitations
+    under the License.
+
+ERD Schema of the Database
+''''''''''''''''''''''''''
+
+Here is the current Database schema diagram.

Review Comment:
   If the correct answer is `dev`, we shouldn't be reluctant about putting this there just because there are other internal topics already covered in the docs. We can always move things from the docs into `dev` if we need to. Given that the database is not a user-facing resource - and ideally it would not be an admin-facing one - I personally think it belongs in `dev`. It keeps the docs more focused on typical users' needs.
   
   But I don't feel strongly. In fact, there are arguments for having it in the docs - versioning, for one. If this does end up it in the docs, perhaps we could create an Internals section? That could help transmit the right expectation.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org