yellowadmin/pp-tcms
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add why unittcms (#88)

Browse Source
This commit is contained in:
Takeshi Kimata
2024-10-26 22:28:56 +09:00
committed by GitHub
parent 919556c7be
commit 458fe51e78
9 changed files with 85 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/dev/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Development",
"position": 4
"position": 5
}

2
docs/docs/getstarted/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Get started",
"position": 2
"position": 3
}

2
docs/docs/roadmap/index.md
View File

@@ -1,5 +1,5 @@
---
sidebar_position: 2
sidebar_position: 6
---
# Roadmap

2
docs/docs/usage/_category_.json
View File

@@ -1,4 +1,4 @@
{
"label": "Usage",
"position": 3
"position": 4
}

28
docs/docs/why.md Normal file
View File

@@ -0,0 +1,28 @@
---
sidebar_position: 2
---
# Why UnitTCMS
No matter the product, it is difficult to manage all testing with automated tests alone. Depending on the environment, Some portion of testing often involves manual test cases. In my team, we have been managing test cases using Excel. While Excel is a highly versatile tool, it is not specifically designed for test case management, which can make it inconvenient in certain scenarios.
For example,
- writing long test procedures can lead to oversized cells
- forced horizontal scrolling
- difficult to attach image files.
- the Excel file may become heavy
- Need to aggregate test cases and visualization
- Not ideal for simultaneous editing by multiple people.
Due to these challenges, it becomes clear that a dedicated tool is necessary when managing a substantial number of manual tests.
## Other tools
There are many test case management tools available in the market, which can be categorized into proprietary and open-source solutions.
Proprietary tools often come with modern, user-friendly interfaces but tend to be cloud-based, which may raise security concerns for some organizations. While some of them do offer on-premises options, these tend to be significantly more expensive.
There are also open-source tools, but many feature older user interfaces that involve frequent page reloads, which can hinder usability.
With these challenges in mind, I set out to develop a modern, user-friendly, open-source test case management tool that anyone can use for free in a secure, self-hosted environment.

30
docs/src/css/custom.css
View File

@@ -6,25 +6,25 @@
/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #205d3b;
--ifm-color-primary-dark: #29784c;
--ifm-color-primary-darker: #277148;
--ifm-color-primary-darkest: #205d3b;
--ifm-color-primary-light: #33925d;
--ifm-color-primary-lighter: #359962;
--ifm-color-primary-lightest: #3cad6e;
--ifm-color-primary: #28d06c;
--ifm-color-primary-dark: #24b860;
--ifm-color-primary-darker: #20a256;
--ifm-color-primary-darkest: #1b8a48;
--ifm-color-primary-light: #3add80;
--ifm-color-primary-lighter: #5be593;
--ifm-color-primary-lightest: #7bedaa;
--ifm-code-font-size: 95%;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}
/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #4fddbf;
--ifm-color-primary-dark: #21af90;
--ifm-color-primary-darker: #1fa588;
--ifm-color-primary-darkest: #1a8870;
--ifm-color-primary-light: #29d5b0;
--ifm-color-primary-lighter: #32d8b4;
--ifm-color-primary-lightest: #4fddbf;
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
--ifm-color-primary: #28d06c;
--ifm-color-primary-dark: #24b860;
--ifm-color-primary-darker: #20a256;
--ifm-color-primary-darkest: #1b8a48;
--ifm-color-primary-light: #3add80;
--ifm-color-primary-lighter: #5be593;
--ifm-color-primary-lightest: #7bedaa;
--docusaurus-highlighted-code-line-bg: rgba(255, 255, 255, 0.15);
}

11
docs/src/pages/index.js
View File

@@ -9,15 +9,18 @@ export default function Home() {
const { siteConfig } = useDocusaurusContext();
return (
<Layout title={`Hello from ${siteConfig.title}`} description="Description will go into a meta tag in <head />">
<header className={clsx('hero hero--primary', styles.heroBanner)}>
<header className={clsx('hero', styles.heroBanner)}>
<div className="container">
<Heading as="h1" className="hero__title">
UnitTCMS Docs
</Heading>
<p className="hero__subtitle">Open Source Test Case Management System</p>
<div>
<Link className="button button--secondary button--lg" to="/docs">
Move to Docs📰
<div className={styles.buttons}>
<Link className="button button--primary button--lg" to="/docs">
Docs📰
</Link>
<Link className="button button--secondary button--lg" to="https://github.com/kimatata/unittcms">
GitHub
</Link>
</div>
</div>

6
docs/src/pages/index.module.css
View File

@@ -5,10 +5,15 @@
.heroBanner {
padding: 4rem 0;
text-align: center;
position: relative;
overflow: hidden;
}
.heroTitle {
color: blueviolet;
}
@media screen and (max-width: 996px) {
.heroBanner {
padding: 2rem;
@@ -18,6 +23,7 @@
.buttons {
display: flex;
column-gap: 10px;
align-items: center;
justify-content: center;
}