From 2f4bb02285ffb8cbb85c3cf2da160f52953b6dd8 Mon Sep 17 00:00:00 2001 From: kaushik velusamy Date: Tue, 5 Nov 2024 18:24:40 +0000 Subject: [PATCH 1/3] Adding pointer to docs issues / questions --- docs/issues.md | 9 +++++++++ mkdocs.yml | 1 + 2 files changed, 10 insertions(+) create mode 100644 docs/issues.md diff --git a/docs/issues.md b/docs/issues.md new file mode 100644 index 000000000..78f36e3dc --- /dev/null +++ b/docs/issues.md @@ -0,0 +1,9 @@ +# Questions/Issues on ALCF Docs + +Our ALCF documentations are hosted through GitHub to make it easier to contribute and collaborate. + + +If you find any issues on our documentation page, raise an issue at [ALCF Github user guide webpage](https://github.com/argonne-lcf/user-guides/issues/new). Provide us with a brief description on the documentation issue, page url, section heading and mark the appropriate label type on the right pane. + + +For any other issues kindly email [support@alcf.anl.gov](mailto:support@alcf.anl.gov) diff --git a/mkdocs.yml b/mkdocs.yml index 1f2d35703..ae0f5b38f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -243,6 +243,7 @@ nav: - Data and Software Policies: - Data Policy: policies/data-and-software-policies/data-policy.md - Software Policy: policies/data-and-software-policies/software-policy.md + - Docs Questions/Issues: issues.md not_in_nav: | not_in_nav/ unused/ From 1a83d16e363a459de2e23beddc1fedb7177167df Mon Sep 17 00:00:00 2001 From: kaushik velusamy Date: Tue, 5 Nov 2024 12:59:07 -0600 Subject: [PATCH 2/3] Update docs/issues.md Co-authored-by: Kyle Gerard Felker --- docs/issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/issues.md b/docs/issues.md index 78f36e3dc..fdb40b1f3 100644 --- a/docs/issues.md +++ b/docs/issues.md @@ -1,6 +1,6 @@ # Questions/Issues on ALCF Docs -Our ALCF documentations are hosted through GitHub to make it easier to contribute and collaborate. +The ALCF documentation source code is hosted on GitHub to make it easier to contribute and collaborate. If you find any issues on our documentation page, raise an issue at [ALCF Github user guide webpage](https://github.com/argonne-lcf/user-guides/issues/new). Provide us with a brief description on the documentation issue, page url, section heading and mark the appropriate label type on the right pane. From 927ace35299c696927038b73425328e2a3f2cac5 Mon Sep 17 00:00:00 2001 From: kaushik velusamy Date: Tue, 5 Nov 2024 12:59:21 -0600 Subject: [PATCH 3/3] Update docs/issues.md Co-authored-by: Kyle Gerard Felker --- docs/issues.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/issues.md b/docs/issues.md index fdb40b1f3..817106d43 100644 --- a/docs/issues.md +++ b/docs/issues.md @@ -3,7 +3,7 @@ The ALCF documentation source code is hosted on GitHub to make it easier to contribute and collaborate. -If you find any issues on our documentation page, raise an issue at [ALCF Github user guide webpage](https://github.com/argonne-lcf/user-guides/issues/new). Provide us with a brief description on the documentation issue, page url, section heading and mark the appropriate label type on the right pane. +If you find any issues within these pages, please open an Issue at [ALCF GitHub user guide webpage](https://github.com/argonne-lcf/user-guides/issues/new). Provide us with a brief description of the issue, page URL, section heading, and mark the appropriate label type on the right pane. For any other issues kindly email [support@alcf.anl.gov](mailto:support@alcf.anl.gov)