configu / docs Goto Github PK

View Code? Open in Web Editor NEW

9.0 3.0 10.0 18.12 MB

Shell 0.07% JavaScript 40.20% CSS 8.44% MDX 51.29%

hacktoberfest configuration-management docs

docs's Introduction

Configu Company Website Repo 🚀

Getting Started
Usage
Project Structure
Code Style
- ESLint
- Prettier
- VS Code

Getting Started

Install dependencies

npm install

Fill up the environment variables

cp .env.example .env

An .env file should consist of publicly available included in .env as well as private ones:

ALGOLIA_ADMIN_KEY=

⚠️ Please ask project owners for private variables or, if you have access to Gatsby Dashboard, just pull them out from the Environment variables section.

Usage

Run the website

npm run start

Build the website

npm run build

Run the built website

npm run serve

Clean Gatsby cache

npm run clean

Project Structure

├── src
│   ├── components
│   │  ├── pages — React components that are being used specifically on a certain page
│   │  └── shared — React components that are being used across the whole website
│   ├── constants
│   ├── hooks
│   ├── icons
│   ├── images
│   ├── pages
│   ├── styles
│   ├── templates
│   ├── utils
│   └── html.jsx — HTML template for all generated pages. Read more about it here — gatsbyjs.org/docs/custom-html
├── static
│   ├── fonts
│   └── images
├── gatsby-browser.js — Usage of the Gatsby browser APIs
├── gatsby-config.js — Main configuration file for a Gatsby site
├── gatsby-node.js — Usage of the Gatsby Node APIs
└── gatsby-ssr.js — Usage of the Gatsby server-side rendering APIs

Component Folder Structure

Each component includes

Main JavaScript File
Index File

Each component optionally may include

Folder with images and icons
Folder with data

Also, each component may include another component that follows all above listed rules.

Example structure

component
├── nested-component
│  ├── data
│  │  └── nested-component-lottie-data.json
│  ├── images
│  │  ├── nested-component-image.jpg
│  │  ├── nested-component-inline-svg.inline.svg
│  │  └── nested-component-url-svg.url.svg
│  ├── nested-component.js
│  └── index.js
├── data
│  └── component-lottie-data.json
├── images
│  ├── component-image.jpg
│  ├── component-inline-svg.inline.svg
│  └── component-url-svg.url.svg
├── component.js
└── index.js

Code Style

ESLint

ESLint helps find and fix code style issues and force developers to follow same rules. Current configuration is based on Airbnb style guide.

Additional commands:

npm run lint

Run it to check the current status of eslint issues across project.

npm run lint:fix

Run it to fix all possible issues.

Prettier

Prettier helps to format code based on defined rules. Difference between Prettier and ESLint.

Additional commands:

npm run format

Run it to format all files across the project.

VS Code

Following extensions required to simplify the process of keeping the same code style across the project:

After installation enable "ESLint on save" by adding to your VS Code settings.json the following line:

"editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
}

You can navigate to settings.json by using Command Pallete (CMD+Shift+P) and then type "Open settings.json".

To enable Prettier go to Preferences -> Settings -> type "Format". Then check that you have esbenp.prettier-vscode as default formatter, and also enable "Format On Save".

Reload VS Code and auto-format will work for you.

docs's People

Contributors

Stargazers

Watchers

Forkers

girip26 kkpan11 eyesaidyo cstayyab smartmind12 neelshah2409 janumalaakhilendra sanchitmahajan236 arpitpandey29 aman1919

docs's Issues

Adding an examples of how to use the Configu tool to load configuration properties from different configuration sources

Adding an examples of how to use the Configu tool to load configuration properties from different configuration sources
It is necessary to show how we can load properties .

Broken Link on Integrations Page

I found one broken link in the Integrations page.
When I click the Config Editor link in the Integrations page, I get redirected to this page.

Whereas, I should be redirected to this page

I would love to generate a PR to resolve this issue.

Adding define of configuration source and provider

I would like to add definition of configuration source and provider here in the above list .

Update with new `CfguType`s and `ConfigStore`

Broken links on Configu Cloud Platform page

I found one broken link and two wrong links connected in the Configu Cloud Platform page (the page in the image below ) .

If you see carefully in the above image you can see that I have circled three links in total, that's where the problem occurs .
Exact problems are as follows :-

History & Versioning Link
I get redirected to this broken link when I click on this link .

Whereas this is the right page to which I should get redirected .

Permissions Link
In this one I get redirected to the wrong page, i.e., the settings page .

Whereas the write page to be redirected to is the authorization page as it contains the content about roles and permissions .

Tokens Link
In tokens, I get redirected to the settings page that is same as in the case of permissions link, whereas I should get redirected to the tokens page .

I would love to generate a PR to resolve this issue, So, can you please assign it to me given this issue is valid .

Documentation for improved webhooks feature

Basic webhooks usage detailing how to use the feature
Document webhook usage with popular communication integrations
- Discord
- Slack
- Microsoft teams
- Telegram (BONUS)
Document webhook usage with popular CI/CD integrations:
- Github actions
- Gitlab ci/cd (BONUS)
- Circle ci (BONUS)

Actual behavior

There is a broken link in the config schema page, view the image below.

To Reproduce

Open the config schema page and view the link.

Expected behavior

The second /docs/ should not be a part of the link.

Screenshots

Additional context

This issue does not occur in the development environment.