init project

.github/workflows/main.yaml

@@ -0,0 +1,71 @@
+# Sample workflow for building and deploying a Hugo site to GitHub Pages
+name: Deploy Hugo site to Pages
+
+on: [push, pull_request]
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    env:
+      HUGO_VERSION: 0.122.0
+    steps:
+      - name: Install Hugo CLI
+        run: |
+          wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
+          && sudo dpkg -i ${{ runner.temp }}/hugo.deb
+      - name: Install Dart Sass
+        run: sudo snap install dart-sass
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          fetch-depth: 0
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Install Node.js dependencies
+        run: "[[ -f package-lock.json || -f npm-shrinkwrap.json ]] && npm ci || true"
+      - name: Build with Hugo
+        env:
+          # For maximum backward compatibility with Hugo modules
+          HUGO_ENVIRONMENT: production
+          HUGO_ENV: production
+        run: |
+          hugo \
+            --gc \
+            --minify \
+            --baseURL "${{ steps.pages.outputs.base_url }}/"
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v2
+        with:
+          path: ./public
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v3

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "themes/hugo-book"]
+	path = themes/hugo-book
+	url = https://github.com/alex-shpak/hugo-book

archetypes/default.md

@@ -0,0 +1,5 @@
++++
+title = '{{ replace .File.ContentBaseName "-" " " | title }}'
+date = {{ .Date }}
+draft = true
++++

config.yaml

@@ -0,0 +1,97 @@
+# hugo server --minify --themesDir ../.. --baseURL=http://0.0.0.0:1313/theme/hugo-book/
+
+baseURL: https://TourManager.com/
+title: Hugo Book
+theme: hugo-book
+
+# Book configuration
+disablePathToLower: true
+enableGitInfo: true
+
+# Needed for mermaid/katex shortcodes
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+  tableOfContents:
+    startLevel: 1
+
+menu:
+  # before: []
+  after:
+    - name: "Github"
+      url: "https://github.com/Alyona-art/TourManager-Documentation"
+      weight: 10
+
+params:
+  # (Optional, default light) Sets color theme: light, dark or auto.
+  # Theme 'auto' switches between dark and light modes based on browser/os preferences
+  BookTheme: "light"
+
+  # (Optional, default true) Controls table of contents visibility on right side of pages.
+  # Start and end levels can be controlled with markup.tableOfContents setting.
+  # You can also specify this parameter per page in front matter.
+  BookToC: true
+
+  # (Optional, default favicon.png) Set the path to a favicon file.
+  # If the favicon is /static/favicon.png then the path would be favicon.png
+  # BookFavicon: "favicon.png"
+
+  # (Optional, default none) Set the path to a logo for the book.
+  # If the logo is /static/logo.png then the path would be logo.png
+  # BookLogo: /logo.png
+
+  # (Optional, default none) Set leaf bundle to render as side menu
+  # When not specified file structure and weights will be used
+  # BookMenuBundle: /menu
+
+  # (Optional, default docs) Specify root page to render child pages as menu.
+  # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
+  # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
+  BookSection: docs
+
+  # Set source repository location.
+  # Used for 'Last Modified' and 'Edit this page' links.
+  BookRepo: https://github.com/Alyona-art/TourManager-Documentation
+
+  # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
+  # commit hash for 'doc' page type.
+  # Requires 'BookRepo' param.
+  # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
+  # Github uses 'commit', Bitbucket uses 'commits'
+  # BookCommitPath: commit
+
+  # Enable "Edit this page" links for 'doc' page type.
+  # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
+  # Edit path must point to root directory of repo.
+  # BookEditPath: edit/main/exampleSite
+
+  # Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  BookDateFormat: "January 2, 2006"
+
+  # (Optional, default true) Enables search function with flexsearch,
+  # Index is built on fly, therefore it might slowdown your website.
+  # Configuration for indexing can be adjusted in i18n folder per language.
+  BookSearch: true
+
+  # (Optional, default true) Enables comments template on pages
+  # By default partals/docs/comments.html includes Disqus template
+  # See https://gohugo.io/content-management/comments/#configure-disqus
+  # Can be overwritten by same param in page frontmatter
+  BookComments: true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
+  # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
+  # Theme will print warning if page referenced in markdown does not exists.
+  BookPortableLinks: true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
+  BookServiceWorker: true
+
+  # /!\ This is an experimental feature, might be removed or changed at any time
+  # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
+  BookTranslatedOnly: false

content/_index.md

@@ -0,0 +1,13 @@
+---
+title: Tech Communicational Final Project
+date: 2024-05-09T12:00:00-05:00
+---
+
+# On my way to becoming a Technical Writer
+
+This website is designed for the final project from the elective course "Technical Communication", Innopolis University.
+
+## Hello there
+I'm Alyona Artemeva. If you want to contact me, please use [Telegram](https://t.me/Art_libra) or [email](mailto:a.artemeva@innopolis.university). 
+
+[Github repository for this page.](https://github.com/Alyona-art/TourManager-Documentation)

content/docs/external/frequently_asked_questions.md

@@ -0,0 +1,15 @@
+---
+title: Frequently Asked Questions (FAQs)
+---
+
+{{< expand "First Question" ">" >}}
+Some answer to the first question
+{{< /expand >}}
+
+{{< expand "Second Question" ">" >}}
+Some answer to the second question
+{{< /expand >}}
+
+{{< expand "Another One Question" ">" >}}
+Some answer to the another question
+{{< /expand >}}

content/docs/external/troubleshooting_guide.md

@@ -0,0 +1,11 @@
+---
+title: Troubleshooting guide
+---
+
+# Problems with Authentication
+
+{{< tabs "uniqueid" >}}
+{{< tab "MacOS" >}} # MacOS Solution {{< /tab >}}
+{{< tab "Linux" >}} # Linux Solution {{< /tab >}}
+{{< tab "Windows" >}} # Windows Solution {{< /tab >}}
+{{< /tabs >}}

content/docs/internal/product-requirement-doc.md

@@ -0,0 +1,39 @@
+---
+title: Product Requirement Document
+---
+
+# Problems the software will solve
+
+The main goal of the project is to connect managers and guides for faster and more comfortable communication.
+
+It will solve the next problems:
+
+- Difficult сollaboration between managers and guides.
+- Long process for booking excursions and low application coverage.
+
+# The development approach
+
+## Agile model
+
+Since the project is a startup, the best development solution would be a fast and incremental method such as Agile.
+
+## The order of software development
+
+|  Project Roadmap  |
+| :---------------: | --------------------------------- | ----------- |
+|       Dates       | List of features                  | Stage       |
+| :---------------- | :------                           | :----:      |
+|   13.05 - 19.05   | Setting up architecture and SI/SD | Development |
+|   20.05 - 26.05   | Registration and Log in screens   | Analytics   |
+|        ...        | ...                               | ...         |
+
+# Roles for the project and each team member's responsibilities
+
+- Petr Ivanov (p.ivanov@gmail.com) - Client
+
+- Ivan Petrov (i.petrov@gmail.com) - Product Manager
+- ... - Business Analyst
+- ... - Designer
+- ... - Developer
+- ... - Developer
+- ... - QA

content/docs/internal/stakeholder-analysis-report.md

@@ -0,0 +1,14 @@
+---
+title: Stakeholder Analysis Report
+---
+
+# Some excursion agency:
+
+- They have a pool of guides of more than 30 people
+- About 10 excursions a day are actively conducted
+- For communication, we need to prepare a presentation for their management department with all the preliminary statistics and approximate release dates.
+
+# Another excursion company at the museum:
+
+- They have 3 permanent employees who often forget about scheduled excursions.
+- ...

content/menu/index.md

@@ -0,0 +1,11 @@
++++
+headless = true
++++
+
+- [**Internal Docs**]({{< relref "/docs/internal" >}})
+  - [Product Requirement Document]({{< relref "/docs/internal/product-requirement-doc" >}})
+  - [Stakeholder Analysis Report]({{< relref "/docs/internal/stakeholder-analysis-report" >}})
+
+- [**External Docs**]({{< relref "/docs/external" >}})
+  - [Frequently Asked Questions]({{< relref "/docs/external/frequently_asked_questions" >}})
+  - [Troubleshooting guide]({{< relref "/docs/external/troubleshooting_guide" >}})

hugo.toml

@@ -0,0 +1,4 @@
+baseURL = 'https://alyona-tech-communication.org/'
+languageCode = 'en-us'
+title = 'Technical Communication'
+theme = 'hugo-book'

public/404.html

@@ -0,0 +1,101 @@
+<!DOCTYPE html>
+<html lang="en-us">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+
+    <title>First Hugo Site for TC course</title>
+    <meta name="viewport" content="width=device-width,minimum-scale=1">
+    <meta name="description" content="">
+    <meta name="generator" content="Hugo 0.122.0">
+
+
+
+
+      <meta name="robots" content="noindex, nofollow">
+
+
+
+<link rel="stylesheet" href="/ananke/css/main.min.css" >
+
+
+
+
+
+
+
+
+
+
+
+
+
+      <link rel="canonical" href="https://my-first-hugo-site.org/404.html">
+
+
+    <meta property="og:title" content="404 Page not found" />
+<meta property="og:description" content="" />
+<meta property="og:type" content="website" />
+<meta property="og:url" content="https://my-first-hugo-site.org/404.html" />
+
+<meta itemprop="name" content="404 Page not found">
+<meta itemprop="description" content=""><meta name="twitter:card" content="summary"/><meta name="twitter:title" content="404 Page not found"/>
+<meta name="twitter:description" content=""/>
+
+
+  </head>
+
+  <body class="ma0 avenir bg-near-white">
+
+
+
+  <header>
+    <div class="bg-black">
+      <nav class="pv3 ph3 ph4-ns" role="navigation">
+  <div class="flex-l justify-between items-center center">
+    <a href="/" class="f3 fw2 hover-white no-underline white-90 dib">
+
+        First Hugo Site for TC course
+
+    </a>
+    <div class="flex-l items-center">
+
+
+
+
+<div class="ananke-socials">
+
+</div>
+
+    </div>
+  </div>
+</nav>
+
+    </div>
+  </header>
+
+
+    <main class="pb7" role="main">
+
+    <article class="center cf pv5 measure-wide-l">
+      <h1>
+        This is not the page you were looking for
+      </h1>
+    </article>
+
+    </main>
+    <footer class="bg-black bottom-0 w-100 pa3" role="contentinfo">
+  <div class="flex justify-between">
+  <a class="f4 fw4 hover-white no-underline white-70 dn dib-ns pv2 ph3" href="https://my-first-hugo-site.org/" >
+    &copy;  First Hugo Site for TC course 2024 
+  </a>
+    <div>
+<div class="ananke-socials">
+
+</div>
+</div>
+  </div>
+</footer>
+
+  </body>
+</html>