sfirke commented on code in PR #26923: URL: https://github.com/apache/superset/pull/26923#discussion_r1474658169
########## docs/docs/installation/docker.mdx: ########## @@ -0,0 +1,51 @@ +# Docker Images and Tags + +The Apache Superset community extensively uses Docker for development, release, +and productionizing Superset. This page details our Docker builds and tag naming +schemes to help users navigate our offerings. + +Images are built and pushed to the [Superset Docker Hub repository]( +https://hub.docker.com/r/apache/superset). Different sets of images are created for: +- Published releases, with tags like `3.0.0` and the `latest` tag. +- Pull request iterations, each identified by tags starting with a SHA like + `8a2f7d378ab13c156fa183d9284b607ed69f5ecc`, and `pr-3454`, referencing the pull + request ID. +- Merges to the main branch (`master`), resulting in new SHAs, with tags + prefixed with `master` for the latest `master` version. + +Each code version has multiple builds for different purposes, identified by suffixes: +- **Build Preset:** We offer various images for different needs: Review Comment: Does "Preset" here refer to the company? Or does it mean "prefix" or something else? If it's not referring to Preset the company, it may be clearer to use another term. ########## docs/docs/installation/docker.mdx: ########## @@ -0,0 +1,51 @@ +# Docker Images and Tags + +The Apache Superset community extensively uses Docker for development, release, +and productionizing Superset. This page details our Docker builds and tag naming +schemes to help users navigate our offerings. + +Images are built and pushed to the [Superset Docker Hub repository]( +https://hub.docker.com/r/apache/superset). Different sets of images are created for: +- Published releases, with tags like `3.0.0` and the `latest` tag. +- Pull request iterations, each identified by tags starting with a SHA like + `8a2f7d378ab13c156fa183d9284b607ed69f5ecc`, and `pr-3454`, referencing the pull + request ID. +- Merges to the main branch (`master`), resulting in new SHAs, with tags + prefixed with `master` for the latest `master` version. + +Each code version has multiple builds for different purposes, identified by suffixes: +- **Build Preset:** We offer various images for different needs: + - **Lean:** The default Docker image, including both frontend and backend. Tags + without a build_preset are lean builds, e.g., `latest`. + - **Dev:** For development, with a headless browser and root access. + - **Py310:** Similar to lean but with Python 3.10. Review Comment: ```suggestion - **PyXXX, e.g., Py310:** Similar to lean but with a different Python version (in this example, 3.10). ``` ########## docs/README.md: ########## @@ -16,4 +16,7 @@ KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> -This is the public documentation site for Superset, built using [Docusaurus 2](https://docusaurus.io/). See [CONTRIBUTING.md](../CONTRIBUTING.md#documentation) for documentation on contributing to documentation. +This is the public documentation site for Superset, built using Review Comment: On a recent PR I was advised by @john-bodley not to add manual line breaks in the docs: https://github.com/apache/superset/pull/26038#discussion_r1401314027 . It seems like these are added manual breaks, and then the new docs page has manual breaks? I don't see any guidance either way in our style guide or contributing guidelines. ########## docs/docs/installation/docker.mdx: ########## @@ -0,0 +1,51 @@ +# Docker Images and Tags + +The Apache Superset community extensively uses Docker for development, release, +and productionizing Superset. This page details our Docker builds and tag naming +schemes to help users navigate our offerings. + +Images are built and pushed to the [Superset Docker Hub repository]( +https://hub.docker.com/r/apache/superset). Different sets of images are created for: +- Published releases, with tags like `3.0.0` and the `latest` tag. +- Pull request iterations, each identified by tags starting with a SHA like + `8a2f7d378ab13c156fa183d9284b607ed69f5ecc`, and `pr-3454`, referencing the pull + request ID. +- Merges to the main branch (`master`), resulting in new SHAs, with tags + prefixed with `master` for the latest `master` version. + +Each code version has multiple builds for different purposes, identified by suffixes: +- **Build Preset:** We offer various images for different needs: + - **Lean:** The default Docker image, including both frontend and backend. Tags + without a build_preset are lean builds, e.g., `latest`. + - **Dev:** For development, with a headless browser and root access. + - **Py310:** Similar to lean but with Python 3.10. + - **CI:** For certain CI workloads. + - **WebSocket:** For Superset clusters supporting advanced features. + - **Dockerize:** Used by Helm. +- **Platform:** We build for `linux/arm64` and `linux/amd64`. The `-arm` suffix + indicates ARM builds (e.g., `latest-arm`), while tags without a suffix are for + AMD (e.g., `latest`). Review Comment: I see people asking about ARM builds for certain Mac chipsets. If we know of any that require ARM, maybe we state that here. ########## docs/docs/installation/docker.mdx: ########## @@ -0,0 +1,51 @@ +# Docker Images and Tags + +The Apache Superset community extensively uses Docker for development, release, +and productionizing Superset. This page details our Docker builds and tag naming +schemes to help users navigate our offerings. + +Images are built and pushed to the [Superset Docker Hub repository]( +https://hub.docker.com/r/apache/superset). Different sets of images are created for: +- Published releases, with tags like `3.0.0` and the `latest` tag. +- Pull request iterations, each identified by tags starting with a SHA like + `8a2f7d378ab13c156fa183d9284b607ed69f5ecc`, and `pr-3454`, referencing the pull + request ID. +- Merges to the main branch (`master`), resulting in new SHAs, with tags + prefixed with `master` for the latest `master` version. + +Each code version has multiple builds for different purposes, identified by suffixes: +- **Build Preset:** We offer various images for different needs: + - **Lean:** The default Docker image, including both frontend and backend. Tags + without a build_preset are lean builds, e.g., `latest`. + - **Dev:** For development, with a headless browser and root access. + - **Py310:** Similar to lean but with Python 3.10. + - **CI:** For certain CI workloads. + - **WebSocket:** For Superset clusters supporting advanced features. + - **Dockerize:** Used by Helm. +- **Platform:** We build for `linux/arm64` and `linux/amd64`. The `-arm` suffix + indicates ARM builds (e.g., `latest-arm`), while tags without a suffix are for + AMD (e.g., `latest`). + +## Key Image Tags and Examples + +- `latest`: The latest official release build, implicitly the lean build on + `linux/amd64`. +- `latest-dev` Review Comment: ```suggestion - `latest-dev`: the `-dev` image of the latest official release build, with a headless browser and root access. ``` -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
