Skip to content

chore: improvements #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions apps/docs/content/dotnet/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger .NET build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
24 changes: 21 additions & 3 deletions apps/docs/content/features/pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Build & deploy pipeline
---

import Image from "/src/components/Image"

## Configure the pipeline
Zerops provides a customizable build and runtime environment for your application.
Start by adding a [zerops.yml](/references/zeropsyml) file to the **root of your repository** and modify it to fit your application.
Expand Down Expand Up @@ -45,14 +47,25 @@ Learn more about all `zerops.yml` parameters for your runtime:
## Trigger the pipeline

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

### Automatically
Trigger the build & deploy pipeline automatically with each push to the selected branch or with a new tag. Create a new runtime service and connect it to your GitHub repository or GitLab repository.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
caption="Github Integration via Zerops GUI"
/>
</p>

### Manually
Expand Down Expand Up @@ -90,7 +103,12 @@ If you just want to [deploy](#deploy-phase) your already built application to Ze
## Build phase

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step2.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-2.webp"
darkImage="/img/mind-maps/build-deploy/step-2.webp"
alt="build deploy pipeline step 2"
style={{ width: '95%', height: 'auto' }}
/>
</p>

Zerops starts a temporary build container and performs following actions:
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/go/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Go build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
1 change: 0 additions & 1 deletion apps/docs/content/help/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ import Accordion from "/src/components/Accordion"
Docusaurus is an open-source static site generator that helps you build optimized websites quickly, focusing on documentation sites.
</Accordion> */}


<details>
<summary>1. What is the Zerops GUI URL?</summary>
<p>
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/java/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Java build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/nginx/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Nginx build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/nodejs/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Node.js build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/php/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger PHP build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/python/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Python build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/content/references/github-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Zerops needs full access to your repositories on GitHub to be able to configure
5. Or choose the **Push to branch** option and select the branch from the list. Every push to the selected branch will trigger a new build & deploy pipeline, unless you [skip the pipeline](#skip-the-automatic-pipeline-once) with a specific commit message.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<img src="/img/gui/github-integration.webp" alt="image" width="95%" height="auto"/>
</p>

### Skip the automatic pipeline once
Expand Down
16 changes: 14 additions & 2 deletions apps/docs/content/rust/how-to/trigger-pipeline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,15 @@
title: Trigger Rust build & deploy pipeline
---

import Image from "/src/components/Image"

<p align="center">
<img src="/img/screenshots/build_deploy_pipeline-step1.png" alt="image" width="100%" height="auto"/>
<Image
lightImage="/img/mind-maps/build-deploy/step-1.webp"
darkImage="/img/mind-maps/build-deploy/step-1-dark.webp"
alt="build deploy pipeline"
style={{ width: '95%', height: 'auto' }}
/>
</p>

## Automatic builds and deploys from GitHub or GitLab
Expand All @@ -16,7 +23,12 @@ Follow these steps:
Then each time you create a new tag or push to a specific branch, depending on the configuration, GitHub or GitLab will initiate a new build & deploy pipeline.

<p align="center">
<img src="/img/screenshots/github_integration.png" alt="image" width="70%" height="auto"/>
<Image
lightImage="/img/gui/github-integration.webp"
darkImage="/img/gui/github-integration.webp"
alt="github integration"
style={{ width: '95%', height: 'auto' }}
/>
</p>

:::info
Expand Down
20 changes: 10 additions & 10 deletions apps/docs/src/components/Accordion/index.tsx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
import React, { useState, ReactNode } from "react"
import React, { useState, ReactNode } from 'react';

interface AccordionProps {
title: string
children: ReactNode
title: string;
children: ReactNode;
}

const Accordion: React.FC<AccordionProps> = ({ title, children }) => {
const [isOpen, setIsOpen] = useState(false)
const [isOpen, setIsOpen] = useState(false);

const toggleAccordion = () => {
setIsOpen(!isOpen)
}
setIsOpen(!isOpen);
};

return (
<div className="border border-gray-300 rounded mb-4">
Expand All @@ -19,11 +19,11 @@ const Accordion: React.FC<AccordionProps> = ({ title, children }) => {
onClick={toggleAccordion}
>
<span className="text-lg">{title}</span>
<span className="text-xl font-bold">{isOpen ? "-" : "+"}</span>
<span className="text-xl font-bold">{isOpen ? '-' : '+'}</span>
</button>
{isOpen && <div className="p-4 bg-white">{children}</div>}
</div>
)
}
);
};

export default Accordion
export default Accordion;
34 changes: 15 additions & 19 deletions apps/docs/src/components/Image/index.tsx
Original file line number Diff line number Diff line change
@@ -1,25 +1,21 @@
import React from "react"
import useBaseUrl from "@docusaurus/useBaseUrl"
import { useColorMode } from "@docusaurus/theme-common"
import React from 'react';
import useBaseUrl from '@docusaurus/useBaseUrl';
import { useColorMode } from '@docusaurus/theme-common';

type ImageProps = {
lightImage: string
darkImage: string
alt: string
[key: string]: any
}
lightImage: string;
darkImage?: string;
alt: string;
caption?: string;
[key: string]: any;
};

const Image: React.FC<ImageProps> = ({
lightImage,
darkImage,
alt,
...props
}) => {
const { colorMode } = useColorMode()
const Image: React.FC<ImageProps> = ({ lightImage, darkImage, alt, caption, ...props }) => {
const { colorMode } = useColorMode();

const imageUrl = colorMode === "dark" ? darkImage : lightImage
const imageUrl = colorMode === 'dark' ? darkImage : lightImage;

return <img src={useBaseUrl(imageUrl)} alt={alt} {...props} />
}
return <div className="py-0.5 text-center text-sm flex flex-col "><img className="mx-auto" src={useBaseUrl(imageUrl)} alt={alt} {...props} /><span className="pt-0.5 opacity-65">{caption}</span></div>;
};

export default Image
export default Image;
Loading
Loading