diff --git a/README.md b/README.md index 5ba47c3b5..239765e43 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This application defines global templates for [GOV.UK](https://www.gov.uk) pages ## Screenshots -![screenshot](/doc/screenshot.png?raw=true) +![screenshot](/docs/screenshot.png?raw=true) ## Nomenclature @@ -12,10 +12,10 @@ This application defines global templates for [GOV.UK](https://www.gov.uk) pages ## Technical documentation -- [Image optimisation](doc/image-optimisation.md) -- [Slimmer templates](doc/slimmer_templates.md) -- [Emergency Banner](doc/emergency-banner.md) -- [Analytics](doc/analytics.md) +- [Image optimisation](docs/image-optimisation.md) +- [Slimmer templates](docs/slimmer_templates.md) +- [Emergency Banner](docs/emergency-banner.md) +- [Analytics](docs/analytics.md) ### Running the application diff --git a/app/assets/javascripts/surveys.js b/app/assets/javascripts/surveys.js index ab39d4038..5bf891ce4 100644 --- a/app/assets/javascripts/surveys.js +++ b/app/assets/javascripts/surveys.js @@ -61,7 +61,7 @@ var SURVEY_SEEN_TOO_MANY_TIMES_LIMIT = 2 var MAX_MOBILE_WIDTH = "(max-width: 800px)" - /* This data structure is explained in `doc/surveys.md` */ + /* This data structure is explained in `docs/surveys.md` */ var userSurveys = { defaultSurvey: { url: 'https://www.smartsurvey.co.uk/s/gov_uk?c={{currentPath}}', diff --git a/doc/analytics.md b/docs/analytics.md similarity index 100% rename from doc/analytics.md rename to docs/analytics.md diff --git a/doc/architecture-decisions/0001-record-architecture-decisions.md b/docs/architecture-decisions/0001-record-architecture-decisions.md similarity index 100% rename from doc/architecture-decisions/0001-record-architecture-decisions.md rename to docs/architecture-decisions/0001-record-architecture-decisions.md diff --git a/doc/architecture-decisions/0002-add-enhanced-ecommerce.md b/docs/architecture-decisions/0002-add-enhanced-ecommerce.md similarity index 100% rename from doc/architecture-decisions/0002-add-enhanced-ecommerce.md rename to docs/architecture-decisions/0002-add-enhanced-ecommerce.md diff --git a/doc/emergency-banner.md b/docs/emergency-banner.md similarity index 100% rename from doc/emergency-banner.md rename to docs/emergency-banner.md diff --git a/doc/global-banner.md b/docs/global-banner.md similarity index 98% rename from doc/global-banner.md rename to docs/global-banner.md index 02220386a..8c9cfafc9 100644 --- a/doc/global-banner.md +++ b/docs/global-banner.md @@ -11,7 +11,7 @@ In `app/views/notifications/_global_bar.html.erb` 2. Update the `show_global_bar` variable to `true` 3. Deploy static -![screenshot](/doc/global-banner.png?raw=true) +![screenshot](/docs/global-banner.png?raw=true) If you are in the production environment, once the origin cache is purged the CDN cache will be purged automatically. This will clear cache for the top 10 most visited pages. diff --git a/doc/global-banner.png b/docs/global-banner.png similarity index 100% rename from doc/global-banner.png rename to docs/global-banner.png diff --git a/doc/image-optimisation.md b/docs/image-optimisation.md similarity index 100% rename from doc/image-optimisation.md rename to docs/image-optimisation.md diff --git a/doc/screenshot.png b/docs/screenshot.png similarity index 100% rename from doc/screenshot.png rename to docs/screenshot.png diff --git a/doc/slimmer_templates.md b/docs/slimmer_templates.md similarity index 100% rename from doc/slimmer_templates.md rename to docs/slimmer_templates.md diff --git a/doc/surveys.md b/docs/surveys.md similarity index 100% rename from doc/surveys.md rename to docs/surveys.md diff --git a/doc/test-ecommerce-changes-to-static.md b/docs/test-ecommerce-changes-to-static.md similarity index 100% rename from doc/test-ecommerce-changes-to-static.md rename to docs/test-ecommerce-changes-to-static.md