Sprint Essay 1 about Establishment of the website by FZU Flying Club

---

This assignment belongs to which course	EE308FZ Software Engineering https://bbs.csdn.net/forums/ssynkqtd-04
Where this assignment is required	https://bbs.csdn.net/topics/617606376
Team name	FZU Flying Club
The goal of this assignment	Help students understand Alpha Sprint and promote course project progress
Other references	None

1 Project burn chart

2 Video demonstration of the task of setting up a website

Sprint Plan 1 demonstration video

3 Task code embedding area

3.1 Introduction

The material for MkDocs is the subject of MkDocs, a static site generator for (technical) project documents. If you are familiar with Python, you can install Material for MkDocs using pip (Python package manager). If not, we recommend using docker.

3.2 Create a file

Create a file

$ mkdocs new mkdocs-site
INFO     -  Creating project directory: mkdocs-site
INFO     -  Writing config file: mkdocs-site/mkdocs.yml
INFO     -  Writing initial docs: mkdocs-site/docs/index.md
$ cd mkdocs-site

Directory structure

$ tree -a
.
├── docs
│   └── index.md
└── mkdocs.yml

Add GitHub Workflow

name: publish flying book v2
on:
  push:
    branches:
      - master 
      - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: 3.x
      - uses: actions/cache@v2
        with:
          key: ${{ github.ref }}
          path: .cache
      - run: pip install mkdocs-material 
      - run: mkdocs gh-deploy --force
      

# name: publish flying book
# on: # When the workflow is triggered
# push: # When the local main branch is pushed to the GitHub repository.
# branches.
# - main
# pull_request: # When the main branch is merged with a pr request from someone else.
# branches.
# - main
# jobs: # Workflow specifics
# deploy.
# runs-on: ubuntu-latest # Create a new cloud VM with the latest Ubuntu system
# steps.
# - uses: actions/checkout@v3 # checkout to main branch first
# - uses: actions/setup-python@v4 # Install Python3 and related environments
# with.
# python-version: 3.x
# - uses: actions/cache@v2 # with: # python-version: 3.x
# with: # python-version: 3x # - uses: actions/cache@v2
# key: ${{ github.ref }}
# path: .cache
# - run: pip install mkdocs-material # Install mkdocs-material using the pip package management tool
# - run: mkdocs gh-deploy --force # Deploy gh-pages branch with mkdocs-material

$ tree -a
.
├── .github
│   ├── FUNDING
│   └── workflows
│       └── PublishMySite.yml
├── docs
│   └── index.md
└── mkdocs.yml

Git and GitHub

git init

$ git init
$ git add .
$ git commit -m "init"

GitHub - New Repository

GitHub > New Repository

GitHub > Repository > Settings > Actions > General >

• Actions permissions: Allow all actions and reusable workflows

• Workflow permissions: Read and write permissions

• Click Save

$ git branch -M main
$ git push -u origin main

GitHub > Repository > Settings > Pages > Source > gh-pages > Click Save

4 Task code github repository

Link：
https://github.com/MIECer/FZU-flying-book

*Need VPN

5 Task test process

Enter the address http://127.0.0.1:8000 into your browser on the following page:

While running the site, we can modify the site information in real time. mkdocs will be updated and displayed on the browser for us to preview.

We can modify the site name site_name in the mkdocs.yml file:

site_name: FZU Flying Book

6 Website Test Report

6.1 Introduction

We do this by thoroughly testing a newly created website and evaluating its performance in terms of functionality, performance, security, and user experience. The goal of the test is to ensure that the website can run stably, securely and reliably before going live in order to provide a quality user experience.

6.2 Testing Objectives

The main objectives of this test include:

• Ensure that all functional modules of the website are functioning properly without errors and anomalies.
• Evaluate the performance of the website, including page loading speed, response time and other aspects.
• Check the user interface to ensure that the design conforms to user habits and is easy to use.

6.3 Testing methodology

The following methods were used for testing:

• Performance testing: Performance testing tools were used to evaluate the site’s loading speed, response time and other performance indicators.
• User Experience Test: Invite actual users to participate in the test, collect their feedback, and evaluate the user experience.

6.4 Test Results

• Performance test: The website performs well under normal load.
• User Experience Test: Most users were satisfied with the interface and operation of the website.

6.5 Suggestions and Improvements

Based on the test results, the following recommendations and improvements are proposed:

• Optimise the performance of the website, especially during high load periods, to improve user experience.
• Based on the feedback from the user experience test, carry out interface and navigation optimisation to enhance user-friendliness.

6.6 Conclusion

Overall, the website performed well in the test, with most of the functions working properly and stable performance.