Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[User Guide] Reorganize to prepare for other languages #2354

Merged
merged 10 commits into from
Jul 18, 2023
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
strict: true
theme:
name: material
custom_dir: "../../default/"
palette:
primary: blue
icon:
Expand All @@ -15,13 +16,16 @@ theme:
- search.share
- search.suggest
site_name: The Combine
docs_dir: "../../docs/en"
site_dir: "../../site/en"
use_directory_urls: false
repo_url: https://github.com/sillsdev/TheCombine
edit_uri: edit/master/docs/user_guide/docs/
repo_name: sillsdev/TheCombine
copyright: © 2019-2023 SIL International
plugins:
- search
- search:
lang: en
# This plugin is used to validate URLs (including some anchors).
# Uncomment to build the docs with this validation enabled.
# This is commented out by default because this requires network I/O to validate URLs, so it is
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion nginx/templates/default_http_and_https.conf
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ server {

# User Guide static files.
location /docs {
alias /usr/share/nginx/user_guide;
alias /usr/share/nginx/user_guide/en;
index index.html index.htm;
expires 12h;
add_header Cache-Control "public, no-transform";
Expand Down
2 changes: 1 addition & 1 deletion nginx/templates/default_http_only.conf
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ server {

# User Guide static files.
location /docs {
alias /usr/share/nginx/user_guide;
alias /usr/share/nginx/user_guide/en;
index index.html index.htm;
expires 12h;
add_header Cache-Control "public, no-transform";
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@
"fmt-frontend-check": "prettier --check \"./{.github,.vscode,certmgr,deploy,docs,public,scripts,src}/**/*.{js,jsx,ts,tsx,json,md,yml,yaml}\"",
"frontend": "npm run set-release && react-scripts start",
"gen-backend-coverage-report": "tsc scripts/genBackendCoverageReport.ts && node scripts/genBackendCoverageReport.js",
"license-report-backend": " dotnet-project-licenses --include-transitive --input ./Backend/BackendFramework.csproj --output --outfile docs/user_guide/docs/licenses/backend_licenses.txt",
"license-report-backend": " dotnet-project-licenses --include-transitive --input ./Backend/BackendFramework.csproj --output --outfile docs/user_guide/docs/default/licenses/backend_licenses.txt",
"license-summary-backend": "dotnet-project-licenses --include-transitive --input ./Backend/BackendFramework.csproj",
"license-report-frontend": " npm install && license-checker-rseidelsohn --production --excludePrivatePackages --plainVertical --out docs/user_guide/docs/licenses/frontend_licenses.txt",
"license-report-frontend": " npm install && license-checker-rseidelsohn --production --excludePrivatePackages --plainVertical --out docs/user_guide/docs/default/licenses/frontend_licenses.txt",
"license-summary-frontend": "npm install && license-checker-rseidelsohn --production --excludePrivatePackages --summary",
"lint": " eslint --max-warnings=0 --ext js,ts,tsx,jsx src",
"lint:fix-layout": "eslint --max-warnings=0 --ext js,ts,tsx,jsx src --fix --fix-type layout,suggestion",
Expand Down
6 changes: 3 additions & 3 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -48,21 +48,21 @@ commands =
[testenv:user-guide]
deps =
-r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide
changedir = {toxinidir}/docs/user_guide/config/en
commands =
mkdocs build

[testenv:user-guide-serve]
deps =
-r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide
changedir = {toxinidir}/docs/user_guide/config/en
commands =
mkdocs serve

[testenv:user-guide-github-pages]
deps =
-r{toxinidir}/dev-requirements.txt
changedir = {toxinidir}/docs/user_guide
changedir = {toxinidir}/docs/user_guide/config/en
commands =
# See: https://squidfunk.github.io/mkdocs-material/publishing-your-site/
mkdocs gh-deploy --force