From 8fe0d6c67189d085d89be07c8b267e4afb4425c3 Mon Sep 17 00:00:00 2001 From: sryu Date: Fri, 23 Aug 2024 15:45:09 -0600 Subject: [PATCH 1/3] update evaluate page on docs --- docs/content/docs/evaluate/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/content/docs/evaluate/index.md b/docs/content/docs/evaluate/index.md index 7dbbdc5..5b6417f 100644 --- a/docs/content/docs/evaluate/index.md +++ b/docs/content/docs/evaluate/index.md @@ -10,6 +10,8 @@ The `Evaluate` tab runs a case to generate linearization files at each operating The first step in performing an evaluation is to select the OpenFAST executable by clicking the `Browse` button as shown in the following figure. This action opens a dialog box to select the path to the executable. The dialog will default to the path of `openfast` in the system's path, if one is found. +To paste the OpenFAST executable path direclty from the finder on Mac, we recommend to use ⇧⌘G (Command+Shift+G). + ![evaluate-openfast](evaluate-openfast.png) From a71279a6ef6d3d40d126251e9186107e9c00973c Mon Sep 17 00:00:00 2001 From: sryu Date: Mon, 26 Aug 2024 11:37:03 -0600 Subject: [PATCH 2/3] fix error deprecated - from .Site.IsServer to hugo.IsServer --- docs/themes/hugo-whisper-theme/layouts/_default/baseof.html | 4 ++-- .../hugo-whisper-theme/layouts/partials/google-analytics.html | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/themes/hugo-whisper-theme/layouts/_default/baseof.html b/docs/themes/hugo-whisper-theme/layouts/_default/baseof.html index 4755273..ed31424 100644 --- a/docs/themes/hugo-whisper-theme/layouts/_default/baseof.html +++ b/docs/themes/hugo-whisper-theme/layouts/_default/baseof.html @@ -16,7 +16,7 @@ - {{ if .Site.IsServer }} + {{ if hugo.IsServer }} {{ $style := resources.Get "scss/style.scss" | toCSS (dict "targetPath" "css/style.css" "enableSourceMap" true) }} {{ else }} @@ -67,7 +67,7 @@ {{ block "footer_js" . }} {{ end }} - {{ if .Site.IsServer }} + {{ if hugo.IsServer }} {{ else }} diff --git a/docs/themes/hugo-whisper-theme/layouts/partials/google-analytics.html b/docs/themes/hugo-whisper-theme/layouts/partials/google-analytics.html index 63c84ab..f4d7d73 100644 --- a/docs/themes/hugo-whisper-theme/layouts/partials/google-analytics.html +++ b/docs/themes/hugo-whisper-theme/layouts/partials/google-analytics.html @@ -1,4 +1,4 @@ -{{- if .Site.IsServer -}} +{{- if hugo.IsServer -}} {{ else }} {{ $gid := (getenv "HUGO_GOOGLE_ANALYTICS_ID") }} From 07bc85e71f8c441891a38284ed769fa2e7c8c6c1 Mon Sep 17 00:00:00 2001 From: sryu Date: Mon, 26 Aug 2024 11:39:40 -0600 Subject: [PATCH 3/3] add contribute page for documentation --- docs/content/docs/contribute/index.md | 46 +++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 docs/content/docs/contribute/index.md diff --git a/docs/content/docs/contribute/index.md b/docs/content/docs/contribute/index.md new file mode 100644 index 0000000..9292687 --- /dev/null +++ b/docs/content/docs/contribute/index.md @@ -0,0 +1,46 @@ +--- +title: 'Contribute' +date: 2024-08-22T16:35:17-06:00 +draft: false +weight: 11 +--- + +This page is for describing how to add, improve, and update ACDC documentation. + +### Installation +The documentation is generated using the [Hugo](https://gohugo.io) documentation generator. We recommend running below commands for each machine. + +#### macOS/Linux + +```bash +$ brew install hugo +``` + +#### Windows + +```bash +$ choco install hugo-extended +``` + +Note that Hugo with Extended edition is required for building the documentation with [current theme](https://themes.gohugo.io/themes/hugo-whisper-theme/). Make sure you see **/extended** after the version number, once you run `hugo version`. + + +### Getting started + +#### Add new page +To add a new page, `cd docs` and run: + +```bash +$ hugo new content content/docs/[new_page_name]/index.md +``` + +Open the file with your editor and add contents. + +#### View site +To test your site, run: + +```bash +$ hugo server +``` + +Now enter `localhost:1313` in the address bar of your browser. The server rebuilds your site and refreshes your browser whenever it detects the change. \ No newline at end of file