Skip to content

Commit 73387f3

Browse files
authored
Merge branch 'main' into microservice-error-guessing-glossary-terms
Signed-off-by: Abhishek kushwaha <[email protected]>
2 parents 58c30c6 + 848cc7f commit 73387f3

39 files changed

+1466
-15913
lines changed

.github/ISSUE_TEMPLATE/documentation-request.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
name: Documentation request
33
about: Use this to propose information improvements and additions
4-
title: "[ Documentation request ] "
5-
labels: ''
6-
assignees: ''
7-
4+
title: "[Docs]"
5+
labels: '[Documentation]'
86
---
97

108
# Brief description

.github/pull_request_template.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
1-
# Pull Request Template
1+
## What has changed?
22

3-
## Description
3+
Please include a summary of the change.
44

5-
Please include a summary of the change. Please also include relevant motivation and context. List any dependencies that are required for this change.
6-
7-
Fixes # (issue)
5+
This PR Resolves #(issue)
86

97
## Type of change
108

@@ -13,22 +11,16 @@ Please delete options that are not relevant.
1311
- [ ] Bug fix (non-breaking change which fixes an issue).
1412
- [ ] New feature (non-breaking change which adds functionality).
1513
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected).
16-
- [ ] This change requires a documentation update.
14+
- [ ] Documentation update (if none of the other choices apply).
1715

1816
## How Has This Been Tested?
1917

20-
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
21-
22-
## Additional Context (Please include any Screenshots/gifs if relevant)
18+
Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.
2319

24-
...
2520

2621
## Checklist:
2722

2823
- [ ] My code follows the style guidelines of this project.
2924
- [ ] I have performed a self-review of my own code.
30-
- [ ] I have made corresponding changes to the documentation.
31-
- [ ] I have added corresponding tests.
32-
- [ ] Any dependent changes have been merged and published in downstream modules.
3325

34-
<!--- Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look --->
26+
<!--- Thanks for opening this pull request! If the tests fail, please feel free to reach out to us by leaving a comment down below and we will be happy to take a look --->

.github/workflows/build_and_check.yml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,8 @@ jobs:
2020
with:
2121
node-version: 18.0.0
2222

23-
- name: Install Yarn
24-
run: npm install -g yarn
25-
2623
- name: Install Dependencies
27-
run: yarn install
24+
run: npm install
2825

2926
- name: Build Documentation
30-
run: yarn build
27+
run: npm run build

.github/workflows/lint.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@ jobs:
1515
with:
1616
fetch-depth: 0
1717

18+
- name: Set up Node.js
19+
uses: actions/setup-node@v2
20+
with:
21+
node-version: '18.0.0'
22+
23+
- name: Install Dependencies
24+
run: npm install
25+
1826
- name: Check commits messages
1927
uses: wagoid/commitlint-github-action@v5
2028
env:

.github/workflows/main.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ jobs:
2323
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
2424
- uses: actions/checkout@v2
2525

26-
- name: Set Node.js 18.x
26+
- name: Set Node.js 22.x
2727
uses: actions/setup-node@v3
2828
with:
29-
node-version: 18.x
29+
node-version: 22.x
3030

3131
- uses: borales/actions-yarn@v4
3232
with:

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,13 @@ The Keploy documentation site uses [Docusaurus 2](https://v2.docusaurus.io/), wh
6464
You can make changes locally without previewing them in the browser.
6565
However, if you want to build the site and preview changes in the browser, you need to have [Docusaurus 2 dependencies](https://v2.docusaurus.io/docs/installation/#requirements) installed.
6666

67-
Initialize Docusaurus 2 in the repo by running [`yarn`](https://classic.yarnpkg.com/en/docs/cli/) once in the root directory of the repo.
67+
Initialize Docusaurus 2 in the repo by running [`npm`](https://docs.npmjs.com/cli/v7/commands/npm-install) once in the root directory of the repo.
6868

6969
Now you can build and view the site locally:
7070

7171
```bash
72-
yarn start
72+
npm install
73+
npm start
7374
```
7475

7576
The command starts a local development server and opens a browser window.
@@ -95,17 +96,17 @@ cd docs
9596
3. Install all the dependencies
9697

9798
```sh
98-
yarn install
99+
npm install
99100

100101
## Start the development server.
101102

102-
yarn start
103+
npm start
103104
```
104105

105106
4. To reformat:
106107

107108
```sh
108-
yarn prettier --write '**/*.{js,md}'
109+
npm prettier --write '**/*.{js,md}'
109110
```
110111

111112
5. Check the build status:

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"scripts": {
66
"docusaurus": "docusaurus",
77
"start": "docusaurus start",
8+
"clean": "rimraf build",
89
"build": "docusaurus build",
910
"swizzle": "docusaurus swizzle",
1011
"deploy": "docusaurus deploy",
@@ -25,10 +26,10 @@
2526
"@mdx-js/react": "^3.0.0",
2627
"clsx": "^2.0.0",
2728
"lint": "^0.8.19",
29+
"prism-react-renderer": "^2.1.0",
2830
"react": "^18.2.0",
2931
"react-dom": "^18.2.0",
3032
"react-player": "^2.6.0",
31-
"prism-react-renderer": "^2.1.0",
3233
"remark-typescript-tools": "1.0.9",
3334
"typescript": "5",
3435
"uuid": "^8.3.2",
@@ -61,9 +62,10 @@
6162
"postcss-preset-env": "^7.4.1",
6263
"prettier": "^2.5.1",
6364
"prettier-plugin-tailwindcss": "^0.1.4",
65+
"rimraf": "^6.0.1",
6466
"tailwindcss": "^3.0.1"
6567
},
6668
"engines": {
67-
"node":">=18.0"
69+
"node": ">=18.0"
6870
}
6971
}

src/components/Intro.js

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
44

55
function Languages() {
66
return (
7-
<div className="rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow">
7+
<div className="rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
88
<div className="flex items-center space-x-4">
99
<svg
1010
width="16"
@@ -116,7 +116,7 @@ function Languages() {
116116

117117
function Frameworks() {
118118
return (
119-
<div className="flex flex-col rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow">
119+
<div className="flex flex-col rounded-lg bg-[color:var(--ifm-card-background-color)] p-5 shadow transition hover:shadow-lg hover:shadow-[color:var(--ifm-card-shadow-color)]">
120120
<div className="flex items-center space-x-4">
121121
<svg
122122
className="mb-4 h-10 w-10 rounded-lg bg-[color:var(--ifm-color)] p-2 text-[color:var(--ifm-background-color)]"
@@ -176,7 +176,10 @@ function Frameworks() {
176176
</Link>
177177
</li>
178178
<li className="mt-5 flex flex-col space-y-3 text-lg">
179-
<Link className="flex flex-col items-center justify-center space-y-1 p-6 text-center ">
179+
<Link
180+
to={useBaseUrl("/dependencies/redis")}
181+
className="flex flex-col items-center justify-center space-y-1 p-6 text-center "
182+
>
180183
<img
181184
className="h-8 w-8"
182185
src="/docs/img/redis-logo.svg"

src/css/custom.css

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@
1212

1313
:root {
1414
--ifm-color-primary: #ff914d;
15-
--ifm-color-primary-dark: #E67643;
16-
--ifm-color-primary-darker: #C95919;
15+
--ifm-color-primary-dark: #e67643;
16+
--ifm-color-primary-darker: #c95919;
1717
--ifm-color-primary-darkest: #be2c1b;
18-
--ifm-color-primary-light: #FFD0A0;
19-
--ifm-color-primary-lighter: #FFB575;
18+
--ifm-color-primary-light: #ffd0a0;
19+
--ifm-color-primary-lighter: #ffb575;
2020
--ifm-color-primary-lightest: #ffceb1;
2121
--ifm-code-font-size: 95%;
2222
--doc-sidebar-width: 275px !important;
@@ -28,11 +28,11 @@
2828

2929
html[data-theme="dark"] {
3030
--ifm-color-primary: #ff914d;
31-
--ifm-color-primary-dark: #E67643;
32-
--ifm-color-primary-darker: #C95919;
31+
--ifm-color-primary-dark: #e67643;
32+
--ifm-color-primary-darker: #c95919;
3333
--ifm-color-primary-darkest: #be2c1b;
34-
--ifm-color-primary-light: #FFD0A0;
35-
--ifm-color-primary-lighter: #FFB575;
34+
--ifm-color-primary-light: #ffd0a0;
35+
--ifm-color-primary-lighter: #ffb575;
3636
--ifm-color-primary-lightest: #ffceb1;
3737
--ifm-link-color: var(--ifm-color-primary-lighter);
3838
--ifm-menu-color-active: var(--ifm-color-primary-lighter);
@@ -45,42 +45,44 @@ html[data-theme="dark"] {
4545
--ifm-footer-background-color: #000;
4646
--ifm-card-background-color: #1a1a1a;
4747
--collapse-button-bg-color-dark: transparent;
48-
--ifm-badge-background-color: #F88E34;
48+
--ifm-badge-background-color: #f88e34;
4949
--card-color: rgba(17, 24, 39);
50+
--ifm-card-shadow-color: rgba(255, 255, 255, 0.2);
5051
}
5152

5253
html[data-theme="light"] {
5354
--ifm-blockquote-color: #000000;
5455
--ifm-color-emphasis-300: #505050;
5556
/* --ifm-code-background: var(--ifm-color-primary-lightest); */
5657
--ifm-color-input-background: #ffffff;
57-
--ifm-color: #00163D;
58+
--ifm-color: #00163d;
5859
--ifm-background-color: rgb(249, 250, 251);
5960
--ifm-footer-background-color: #ffffff;
6061
--ifm-card-background-color: #ffffff;
6162
--ifm-badge-background-color: rgba(239, 246, 255);
6263

6364
--card-color: rgba(239, 246, 255);
65+
--ifm-card-shadow-color: rgba(0, 0, 0, 0.2); /* Dark shadow for light theme */
6466
}
6567

6668
@font-face {
67-
font-family: 'Roboto';
69+
font-family: "Roboto";
6870
src: url("../fonts/Roboto-Light.woff2");
6971
font-weight: 400;
7072
font-style: normal;
7173
font-display: swap;
7274
}
7375

7476
@font-face {
75-
font-family: 'Roboto';
77+
font-family: "Roboto";
7678
src: url("../fonts/Roboto-Bold.woff2");
7779
font-weight: 700;
7880
font-style: normal;
7981
font-display: swap;
8082
}
8183

8284
@font-face {
83-
font-family: 'Roboto';
85+
font-family: "Roboto";
8486
src: url("../fonts/Roboto-Light.woff2");
8587
font-weight: 300;
8688
font-style: normal;
@@ -193,7 +195,7 @@ div[class^="sidebar_"] .button svg {
193195

194196
/* Pagination */
195197
.pagination-nav {
196-
@apply flex flex-col items-start justify-center space-y-5 space-x-0 md:flex-row md:space-y-0 md:space-x-10;
198+
@apply flex flex-col items-start justify-center space-x-0 space-y-5 md:flex-row md:space-x-10 md:space-y-0;
197199
}
198200
.pagination-nav__item {
199201
@apply w-full max-w-md;
@@ -204,7 +206,7 @@ div[class^="sidebar_"] .button svg {
204206

205207
/* Navbar */
206208
.navbar__inner {
207-
@apply mx-auto max-w-screen-lg lg:px-10 shadow-none;
209+
@apply mx-auto max-w-screen-lg shadow-none lg:px-10;
208210
}
209211

210212
.navbar__items--right {
@@ -230,7 +232,7 @@ div[class^="sidebar_"] .button svg {
230232
}
231233

232234
/* Footer */
233-
footer {
235+
footer {
234236
margin-top: 4%;
235237
}
236238

@@ -253,7 +255,6 @@ footer svg {
253255

254256
.DocSearch-Button {
255257
@apply mr-[-18px] !important;
256-
257258
}
258259

259260
/* .footer .footer__block {
@@ -408,8 +409,6 @@ footer svg {
408409
.docs-centered-image-size-25 {
409410
max-width: 25%;
410411
}
411-
412-
413412
}
414413

415414
.docs-image-legend-wrapper {
@@ -501,7 +500,9 @@ footer svg {
501500
[data-theme="light"] .prose :where(pre code):not(.not-prose) {
502501
background-color: #ffffff;
503502
}
504-
[data-theme="light"] .prose :where(pre):not(:where([class~=not-prose],[class~=not-prose] *)) {
503+
[data-theme="light"]
504+
.prose
505+
:where(pre):not(:where([class~="not-prose"], [class~="not-prose"] *)) {
505506
background-color: #ffffff;
506507
}
507508

@@ -545,11 +546,11 @@ div[class^="announcementBar_"] {
545546
}
546547

547548
/*Correcting alignment of home icon in navbar breadcrumbs.*/
548-
a[class="breadcrumbs__link"]{
549+
a[class="breadcrumbs__link"] {
549550
padding-top: 2px;
550551
margin-bottom: -10px;
551552
}
552553

553554
[data-theme="dark"] th {
554555
color: white;
555-
}
556+
}

src/pages/concepts/reference/glossary.js

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -161,12 +161,13 @@ function Glossary() {
161161
{new Array(26).fill(0).map((x, i) => (
162162
<button
163163
className={`col-span-1 gap-2 rounded-sm p-3
164-
${state[String.fromCharCode(65 + i)]
165-
? "text-black-200 rounded-3xl bg-orange-200 font-bold shadow-md hover:text-orange-950"
166-
: entries[String.fromCharCode(65 + i)] === undefined
167-
? "bg-transparent text-gray-400" // Modified color class
168-
: "bg-grey-200 rounded-3xl shadow-md"
169-
} `}
164+
${
165+
state[String.fromCharCode(65 + i)]
166+
? "text-black-200 rounded-3xl bg-orange-200 font-bold shadow-md hover:text-orange-950 dark:text-orange-900"
167+
: entries[String.fromCharCode(65 + i)] === undefined
168+
? "bg-transparent text-gray-400" // Modified color class
169+
: "bg-grey-200 rounded-3xl shadow-md"
170+
} `}
170171
key={i}
171172
disabled={
172173
entries[String.fromCharCode(65 + i)] === undefined
@@ -182,13 +183,13 @@ function Glossary() {
182183
<div className="-mb-3 mt-10 flex flex-wrap justify-center gap-4 text-xl font-semibold">
183184
{Object.entries(state).map(([key, value]) => {
184185
return (
185-
<div key={key} className="col-span-3 mb-4 w-1/4">
186+
<div key={key} className="mb-4 w-1/4">
186187
<div key={key}>{value ? key : ""}</div>
187188
{value ? (
188-
<div className="text-l flex grid justify-around">
189-
{entries[key]?.map(({ name, link }, i) => (
189+
<div className="ml-4 flex flex-col justify-around text-xl">
190+
{entries[key]?.map(({name, link}, i) => (
190191
<a
191-
className="text-orange-600 hover:text-orange-950 hover:underline"
192+
className="text-orange-600 hover:text-orange-800 hover:underline"
192193
key={i}
193194
href={link}
194195
>

0 commit comments

Comments
 (0)