From 1f279f2c27c75463e5eb6144fd1609b3d7d8ae8b Mon Sep 17 00:00:00 2001 From: Adam Date: Fri, 13 Oct 2023 09:52:40 -0700 Subject: [PATCH 1/3] Update site with deprecation content --- docs/source/assets/css/_doc.scss | 14 ++++++++++++++ .../documentation/get-started/_get-started.md | 2 +- .../documentation/get-started/_static-files.md | 12 +----------- .../documentation/javascript/_importing.md | 2 +- .../patterns/_interactive-overview.md | 2 +- docs/source/guides/quickstart/demo.html | 6 +++--- docs/source/guides/quickstart/index.html | 10 +++++----- docs/source/index.html | 18 +++++------------- docs/source/layouts/_doc.html | 2 +- docs/source/layouts/_examples.html | 2 +- docs/source/layouts/_guide.html | 2 +- docs/source/layouts/_layout.html | 7 +++++++ docs/source/layouts/_quick-reference.html | 2 +- docs/source/table_of_contents.yml | 9 --------- 14 files changed, 42 insertions(+), 48 deletions(-) diff --git a/docs/source/assets/css/_doc.scss b/docs/source/assets/css/_doc.scss index 37aea71e9..6103fec02 100755 --- a/docs/source/assets/css/_doc.scss +++ b/docs/source/assets/css/_doc.scss @@ -246,3 +246,17 @@ mark { padding-top: $baseline * .8; padding-bottom: $baseline * .55; } + +.deprecation-message { + margin: 1rem; + max-width: 100%; +} + +.deprecation-heading { + font-weight: bold; +} + +.deprecation-description { + margin: 0; + padding: 0; +} diff --git a/docs/source/documentation/get-started/_get-started.md b/docs/source/documentation/get-started/_get-started.md index 369af7737..e0161421f 100644 --- a/docs/source/documentation/get-started/_get-started.md +++ b/docs/source/documentation/get-started/_get-started.md @@ -10,7 +10,7 @@ There are three ways to use Calcite Web: - (a) copying static files into your project - (b) installing via a package manager -- (c) loading files from the cdn +- (c) loading files from a self-hosted cdn By default, Calcite Web expects image files to be located at `../`. If your fonts are elsewhere, set the `$font-path` variable diff --git a/docs/source/documentation/get-started/_static-files.md b/docs/source/documentation/get-started/_static-files.md index 2a4df35b9..02563d51d 100644 --- a/docs/source/documentation/get-started/_static-files.md +++ b/docs/source/documentation/get-started/_static-files.md @@ -1,11 +1 @@ -This is probably the easiest way, but you won't get any of the helpful Sass mixins. If you're looking to get up and running quickly, just [download the latest release](https://github.com/ArcGIS/calcite-web/releases) and move the zipped files to wherever you keep your assets (CSS, JavaScript, images). Be sure to use [the documentation site](http://esri.github.io/calcite-web/) to copy and paste patterns, components, and even a sample html boilerplate. - -You can also use a hosted version of Calcite Web: - -``` - - - - - -``` +If you're looking to get up and running quickly, just [download the latest release](https://github.com/Esri/calcite-web/releases) and move the zipped files to wherever you keep your assets (CSS, JavaScript, images). Be sure to use [the documentation site](http://esri.github.io/calcite-web/) to copy and paste patterns, components, and even a sample html boilerplate. diff --git a/docs/source/documentation/javascript/_importing.md b/docs/source/documentation/javascript/_importing.md index 6b75efbc7..13807b39d 100644 --- a/docs/source/documentation/javascript/_importing.md +++ b/docs/source/documentation/javascript/_importing.md @@ -48,7 +48,7 @@ If `calcite-web.js` is used on a page with no module syntax, it will just attach ```html ... - + diff --git a/docs/source/documentation/patterns/_interactive-overview.md b/docs/source/documentation/patterns/_interactive-overview.md index 9c9f2c254..a17ecfdae 100644 --- a/docs/source/documentation/patterns/_interactive-overview.md +++ b/docs/source/documentation/patterns/_interactive-overview.md @@ -1,3 +1,3 @@ -Interactive patterns rely on `calcite-web.js` to work properly. You must add a reference to `calcite-web.js` (either from the cdn or you can host it yourself). After that, you should startup all the interactive patterns on load with `calcite.init()`. +Interactive patterns rely on `calcite-web.js` to work properly. You must add a reference to `calcite-web.js`. After that, you should startup all the interactive patterns on load with `calcite.init()`. For more on using `calcite-web.js` you can view the [JavaScript Documentation](../javascript/). \ No newline at end of file diff --git a/docs/source/guides/quickstart/demo.html b/docs/source/guides/quickstart/demo.html index 9f91e3c3c..bde953964 100644 --- a/docs/source/guides/quickstart/demo.html +++ b/docs/source/guides/quickstart/demo.html @@ -11,7 +11,7 @@ Your Title - + - + + + + -``` -{% endmarkdown %} - - +

Self Hosted

+

Calcite Web can also be used by referencing self hosted files.

+ Browse releases +
diff --git a/docs/source/layouts/_doc.html b/docs/source/layouts/_doc.html index 58dc681de..c593c08bb 100644 --- a/docs/source/layouts/_doc.html +++ b/docs/source/layouts/_doc.html @@ -5,7 +5,7 @@

Documentation

- Download Latest Release + Download Latest Release