Skip to content

Commit a70d90b

Browse files
NullVoxPopuliNullVoxPopuli
committed
Add docs-app, move docs to docs-app
1 parent 8015c31 commit a70d90b

21 files changed

Lines changed: 2666 additions & 40 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
# misc
1010
/connect.lock
11+
.log/
1112
/.env*
1213
/.pnp*
1314
/.eslintcache

‎docs-app/.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist/
2+
node_modules/
3+
.vitepress/dist
4+
.vitepress/cache

‎docs-app/.vitepress/config.mts‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
// https://vitepress.dev/reference/site-config
4+
export default defineConfig({
5+
title: "ember-exam",
6+
description: "Run your tests with randomization, splitting, and parallelization for beautiful tests.",
7+
themeConfig: {
8+
// https://vitepress.dev/reference/default-theme-config
9+
nav: [
10+
{ text: 'Home', link: '/' },
11+
// { text: 'Examples', link: '/markdown-examples' }
12+
],
13+
14+
sidebar: [
15+
{
16+
text: 'Options',
17+
items: [
18+
{ text: 'Randomization', link: '/randomization' },
19+
{ text: 'Randomization Iterator', link: '/randomization-iterator' },
20+
{ text: 'Generating Module Metadata For Test Execution', link: '/module-metadata' },
21+
{ text: 'Splitting', link: '/splitting' },
22+
{ text: 'Split Test Parallelization', link: '/split-parallel' },
23+
{ text: 'Filtering', link: '/filtering' },
24+
{ text: 'Test Load Balancing', link: '/load-balancing' },
25+
]
26+
},
27+
{
28+
text: 'Advanced Configuration',
29+
items: [
30+
{ text: 'Ember Try & CI Integration', link: '/ember-try-and-ci' },
31+
{ text: 'Test Suite Segmentation', link: '/test-suite-segmentation' },
32+
]
33+
}
34+
],
35+
36+
socialLinks: [
37+
{ icon: 'github', link: 'https://github.com/ember-cli/ember-exam' }
38+
]
39+
}
40+
})

‎docs-app/.vitepress/theme/index.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// https://vitepress.dev/guide/custom-theme
2+
import { h } from 'vue'
3+
import type { Theme } from 'vitepress'
4+
import DefaultTheme from 'vitepress/theme'
5+
import './style.css'
6+
7+
export default {
8+
extends: DefaultTheme,
9+
Layout: () => {
10+
return h(DefaultTheme.Layout, null, {
11+
// https://vitepress.dev/guide/extending-default-theme#layout-slots
12+
})
13+
},
14+
enhanceApp({ app, router, siteData }) {
15+
// ...
16+
}
17+
} satisfies Theme

‎docs-app/.vitepress/theme/style.css‎

Lines changed: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
/**
2+
* Customize default theme styling by overriding CSS variables:
3+
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
4+
*/
5+
6+
/**
7+
* Colors
8+
*
9+
* Each colors have exact same color scale system with 3 levels of solid
10+
* colors with different brightness, and 1 soft color.
11+
*
12+
* - `XXX-1`: The most solid color used mainly for colored text. It must
13+
* satisfy the contrast ratio against when used on top of `XXX-soft`.
14+
*
15+
* - `XXX-2`: The color used mainly for hover state of the button.
16+
*
17+
* - `XXX-3`: The color for solid background, such as bg color of the button.
18+
* It must satisfy the contrast ratio with pure white (#ffffff) text on
19+
* top of it.
20+
*
21+
* - `XXX-soft`: The color used for subtle background such as custom container
22+
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
23+
* on top of it.
24+
*
25+
* The soft color must be semi transparent alpha channel. This is crucial
26+
* because it allows adding multiple "soft" colors on top of each other
27+
* to create a accent, such as when having inline code block inside
28+
* custom containers.
29+
*
30+
* - `default`: The color used purely for subtle indication without any
31+
* special meanings attached to it such as bg color for menu hover state.
32+
*
33+
* - `brand`: Used for primary brand colors, such as link text, button with
34+
* brand theme, etc.
35+
*
36+
* - `tip`: Used to indicate useful information. The default theme uses the
37+
* brand color for this by default.
38+
*
39+
* - `warning`: Used to indicate warning to the users. Used in custom
40+
* container, badges, etc.
41+
*
42+
* - `danger`: Used to show error, or dangerous message to the users. Used
43+
* in custom container, badges, etc.
44+
* -------------------------------------------------------------------------- */
45+
46+
:root {
47+
--vp-c-default-1: var(--vp-c-gray-1);
48+
--vp-c-default-2: var(--vp-c-gray-2);
49+
--vp-c-default-3: var(--vp-c-gray-3);
50+
--vp-c-default-soft: var(--vp-c-gray-soft);
51+
52+
--vp-c-brand-1: var(--vp-c-indigo-1);
53+
--vp-c-brand-2: var(--vp-c-indigo-2);
54+
--vp-c-brand-3: var(--vp-c-indigo-3);
55+
--vp-c-brand-soft: var(--vp-c-indigo-soft);
56+
57+
--vp-c-tip-1: var(--vp-c-brand-1);
58+
--vp-c-tip-2: var(--vp-c-brand-2);
59+
--vp-c-tip-3: var(--vp-c-brand-3);
60+
--vp-c-tip-soft: var(--vp-c-brand-soft);
61+
62+
--vp-c-warning-1: var(--vp-c-yellow-1);
63+
--vp-c-warning-2: var(--vp-c-yellow-2);
64+
--vp-c-warning-3: var(--vp-c-yellow-3);
65+
--vp-c-warning-soft: var(--vp-c-yellow-soft);
66+
67+
--vp-c-danger-1: var(--vp-c-red-1);
68+
--vp-c-danger-2: var(--vp-c-red-2);
69+
--vp-c-danger-3: var(--vp-c-red-3);
70+
--vp-c-danger-soft: var(--vp-c-red-soft);
71+
}
72+
73+
/**
74+
* Component: Button
75+
* -------------------------------------------------------------------------- */
76+
77+
:root {
78+
--vp-button-brand-border: transparent;
79+
--vp-button-brand-text: var(--vp-c-white);
80+
--vp-button-brand-bg: var(--vp-c-brand-3);
81+
--vp-button-brand-hover-border: transparent;
82+
--vp-button-brand-hover-text: var(--vp-c-white);
83+
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
84+
--vp-button-brand-active-border: transparent;
85+
--vp-button-brand-active-text: var(--vp-c-white);
86+
--vp-button-brand-active-bg: var(--vp-c-brand-1);
87+
}
88+
89+
/**
90+
* Component: Home
91+
* -------------------------------------------------------------------------- */
92+
93+
:root {
94+
--vp-home-hero-name-color: transparent;
95+
--vp-home-hero-name-background: -webkit-linear-gradient(
96+
120deg,
97+
#bd34fe 30%,
98+
#41d1ff
99+
);
100+
101+
--vp-home-hero-image-background-image: linear-gradient(
102+
-45deg,
103+
#bd34fe 50%,
104+
#47caff 50%
105+
);
106+
--vp-home-hero-image-filter: blur(44px);
107+
}
108+
109+
@media (min-width: 640px) {
110+
:root {
111+
--vp-home-hero-image-filter: blur(56px);
112+
}
113+
}
114+
115+
@media (min-width: 960px) {
116+
:root {
117+
--vp-home-hero-image-filter: blur(68px);
118+
}
119+
}
120+
121+
/**
122+
* Component: Custom Block
123+
* -------------------------------------------------------------------------- */
124+
125+
:root {
126+
--vp-custom-block-tip-border: transparent;
127+
--vp-custom-block-tip-text: var(--vp-c-text-1);
128+
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
129+
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
130+
}
131+
132+
/**
133+
* Component: Algolia
134+
* -------------------------------------------------------------------------- */
135+
136+
.DocSearch {
137+
--docsearch-primary-color: var(--vp-c-brand-1) !important;
138+
}
139+
140+
141+
142+
.badges {
143+
> p {
144+
display: flex;
145+
gap: 1rem;
146+
justify-content: center;
147+
align-items: center;
148+
}
149+
img, a {
150+
display: inline-flex;
151+
}
152+
153+
}

tests/dummy/app/templates/docs/ember-try-and-ci.md renamed to docs-app/ember-try-and-ci.md

File renamed without changes.

tests/dummy/app/templates/docs/filtering.md renamed to docs-app/filtering.md

File renamed without changes.

‎docs-app/index.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
# https://vitepress.dev/reference/default-theme-home-page
3+
layout: home
4+
5+
hero:
6+
name: "ember-exam"
7+
# text: "Run your tests with randomization, splitting, and parallelization for beautiful tests."
8+
tagline: "Run your tests with randomization, splitting, and parallelization for beautiful tests."
9+
actions:
10+
- theme: brand
11+
text: Quickstart
12+
link: /quickstart
13+
# - theme: alt
14+
# text: API Examples
15+
# link: /api-examples
16+
17+
features:
18+
- title: Partitioning
19+
details: Specify the number of parallel browser instances to use to speed up your test suite.
20+
- title: Load Balancing
21+
details: Balance tests to maximize the effectivess of parallel browsers that would otherwise completely quickly due to happenstance of being given quickly running tests.
22+
- title: Randomization
23+
details: Find and eliminate brittle tests by changing the order of tests within the test suite.
24+
- title: Replay
25+
details: Record and replay test execution order for reliably reproducing potentially flaky behaviors.
26+
---
27+
28+
29+
<span class="badges">
30+
31+
![Build Status](https://github.com/ember-cli/ember-exam/actions/workflows/ci.yml/badge.svg?event=push)
32+
[![NPM Version](https://badge.fury.io/js/ember-exam.svg)][npm]
33+
[![Ember Observer Score](https://emberobserver.com/badges/ember-exam.svg)][score]
34+
35+
</span>
36+
37+
[npm]: https://npmjs.com/package/ember-exam
38+
[score]: https://emberobserver.com/addons/ember-exam
39+
40+
Ember Exam is an addon to allow you more control over how you run your tests when used in conjunction with [ember-qunit](https://github.com/emberjs/ember-qunit). It provides the ability to randomize, split, parallelize, and load-balance your test suite by adding a more robust CLI command.
41+
42+
It started as a way to help reduce flaky tests and encourage healthy test driven development.
43+
44+
[![Introduction to Ember Exam](https://cloud.githubusercontent.com/assets/2922250/22800360/157ad67c-eed7-11e6-8d33-d2c59238c7f1.png)](https://embermap.com/video/ember-exam)
45+
46+

tests/dummy/app/templates/docs/load-balancing.md renamed to docs-app/load-balancing.md

File renamed without changes.

tests/dummy/app/templates/docs/module-metadata.md renamed to docs-app/module-metadata.md

File renamed without changes.

0 commit comments

Comments
 (0)