base docs
This commit is contained in:
@@ -1,47 +1,44 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
label: 'Guides Overview'
|
||||
---
|
||||
import ReactPlayer from "react-player"
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
# Overview
|
||||
User guides provided in this section are proxied to serve as both training and **User Acceptance Tests (UATs)** for all NPIS users as detailed in the [Software Requirements Specification (SRS) Document](project-requirements/SRS#system-users-and-characteristics) to execute their respective [system roles in the same SRS Document](project-requirements/SRS#user-roles).
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
|
||||
### What you'll need
|
||||
Users reading this guide are to select their respective user group/roles in the sidebar on the left under User Guides to complete these UATs and training by expanding the menu to further reveal a breakdown of all the usecases for the system tasks executable by their user role/group.
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 20.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
## Generate a new site
|
||||
:::tip[Specialized Users]
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
Executing certain system task roles does require the user to have the neccesary knowledge underlying the technical standards used to
|
||||
implement the features and functionality pertaining to those tasks. For example:
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
The Admin User Guides do require the admin user to have the technical know how on technical standard (IETF RFC 6749 and 6750) known as **OpenID Connect (OIDC)**, an interoperable authentication protocol based on the OAuth 2.0 framework of specifications.
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
:::
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
:::danger[Missconfigured System]
|
||||
|
||||
## Start your site
|
||||
The failure for a certain user to configure the system right, most certainly causes the system to be unusable.
|
||||
|
||||
Run the development server:
|
||||
:::
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
:::info[Learning Resources]
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
The user guide therefore provides such an introduction to the user in form of a prime, or brief introductory notes on the subject matter. An in the case the where is the is more ground to cover beyond the scope of the project, the guide refers the users to curated resources online like links to learning material, standards, or vendor documentation.
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||
:::
|
||||
<div className="video__wrapper">
|
||||
<ReactPlayer className="video__player" controls height="50%" src="/videos/Big_Buck_Bunny_360_10s_1MB.webm" width="50%" />
|
||||
</div>
|
||||
|
||||
<!-- Adds a import GifPlayer from "react-gif-player"; to the markdown.
|
||||
Inserts html like <GifPlayer gif="https://media.giphy.com/media/VhiAuDYHkNPydiNnOs/giphy.gif" /> -->
|
||||
Reference in New Issue
Block a user