From c510161796eedd4b816498950c9b954e654d7e60 Mon Sep 17 00:00:00 2001 From: Richard Cox Date: Tue, 6 Feb 2024 08:59:32 +0000 Subject: [PATCH] Tidy up docs related to build - remove reference to Dockerfile.dev - move unsupported build steps from public docs to repo docs - add unsupported info to other files in repo docs --- .../build-for-container-registry.md | 6 ++- .../build-methods/other-build-methods.md | 13 ++++++ docs/developer/har-files.md | 2 + docusaurus/docs/getting-started/quickstart.md | 41 ------------------- 4 files changed, 19 insertions(+), 43 deletions(-) rename docs/developer/{ => build-methods}/build-for-container-registry.md (97%) create mode 100644 docs/developer/build-methods/other-build-methods.md diff --git a/docs/developer/build-for-container-registry.md b/docs/developer/build-methods/build-for-container-registry.md similarity index 97% rename from docs/developer/build-for-container-registry.md rename to docs/developer/build-methods/build-for-container-registry.md index b832ef6c1ae..16302a9eb79 100644 --- a/docs/developer/build-for-container-registry.md +++ b/docs/developer/build-methods/build-for-container-registry.md @@ -1,5 +1,7 @@ # Building an Image for Container Registries +> ⚠️ Documentation in this directory is intended for internal use only. Any information contained here is unsupported. + Sometimes you may need to have a custom version of the dashboard that is packaged alongside Rancher to be hosted within Github's [container registry](https://docs.github.com/en/packages). There are a few use cases for this, for instance when developing a package/product for Rancher that doesn't need to be standalone or when it isn't necessary for the package to exist in the Dashboard by default. --- @@ -46,8 +48,8 @@ WORKDIR /src COPY . . RUN yarn --pure-lockfile install -ENV ROUTER_BASE="/dashboard" \ - RESOURCE_BASE="/dashboard" +ENV ROUTER_BASE="/dashboard/" \ + RESOURCE_BASE="/dashboard/" RUN yarn run build FROM rancher/rancher:v2.8-head diff --git a/docs/developer/build-methods/other-build-methods.md b/docs/developer/build-methods/other-build-methods.md new file mode 100644 index 00000000000..80dcb8331bd --- /dev/null +++ b/docs/developer/build-methods/other-build-methods.md @@ -0,0 +1,13 @@ +## Other Building Modes + +> ⚠️ Documentation in this directory is intended for internal use only. Any information contained here is unsupported. + + +```bash +# Build for standalone use within Rancher +# (These are done on commit/tag via Drone) +./scripts/build-embedded # for embedding into rancher builds +./scripts/build-hosted # for hosting on a static file webserver and pointing Rancher's ui-dashboard-index at it +# Output in dist/ + +``` diff --git a/docs/developer/har-files.md b/docs/developer/har-files.md index 37698e26f25..bb30240e80c 100644 --- a/docs/developer/har-files.md +++ b/docs/developer/har-files.md @@ -1,5 +1,7 @@ # Using HAR Files +> ⚠️ Documentation in this directory is intended for internal use only. Any information contained here is unsupported. + A HAR file can be created from a web browser (such as Chrome) and can contain performance data but also the network requests captured over a period of time. A HAR file can therefore be a useful tool for debugging and analyzing a UI problem. diff --git a/docusaurus/docs/getting-started/quickstart.md b/docusaurus/docs/getting-started/quickstart.md index 542a9c918f5..a46d273fb9e 100644 --- a/docusaurus/docs/getting-started/quickstart.md +++ b/docusaurus/docs/getting-started/quickstart.md @@ -26,44 +26,3 @@ API=https://your-rancher yarn dev > Note: `API` is the URL of a deployed Rancher environment (backend API) -## Other Building Modes - -> This documentation is out of date - -```bash -# Build for standalone use within Rancher -# (These are done on commit/tag via Drone) -./scripts/build-embedded # for embedding into rancher builds -./scripts/build-hosted # for hosting on a static file webserver and pointing Rancher's ui-dashboard-index at it -# Output in dist/ - -# Build and run with server-side-rendering -# (This method and SSR are not currently used, but should be maintained for future) -yarn build -yarn start - -# Develop via Docker instead of a local nodejs -docker build -f Dockerfile.dev -t dashboard:dev . -docker run -v $(pwd):/src \ - -v dashboard_node:/src/node_modules \ - -p 8005:8005 \ - -e API=https://your-rancher \ - dashboard:dev -# The first time will take *forever* installing node_modules into the volume; it will be faster next time. -# Goto https://localhost:8005 - -# Developing against a standalone "Steve" API on a Mac -git clone https://github.com/rancher/steve.git -cd steve -make run-host - -cd dashboard -docker build -f Dockerfile.dev -t rancher/dashboard:dev . -docker run -v $(pwd):/src \ - -v dashboard_node:/src/node_modules \ - -p 8005:8005 \ - -e API=http://172.17.0.1:8989 \ - rancher/dashboard:dev -# The first time will take *forever* installing node_modules into the volume; it will be faster next time. -# Goto https://localhost:8005 -```