Skip to content

Commit

Permalink
Feat/doc (#60)
Browse files Browse the repository at this point in the history
* feat: init doc

* chore: remove unecessaries 1

* fix: config

* chore: structure

* chore: remove yarn

* chore: use yarn, without s3

* fix: deploy

* chore: use normal script to build & deploy

* fix: without s3

* fix: theme provider

* chore: move theme wrapper

* chore: move themeprovider

* chore: version

* chore: theme ui version

* fix: add provider again

* fix: use case route in doc menu

* chore: without provider

* fix: dark color mode

* fix: search, style

* chore: meta

* chore: fonts1

* chore: font 2

* fix: css 1

* chore: font & style

* chore: term's map, plugins

* chore: fonts

* chore: redirects list

* chore: use original font for doc

* chore: link-check

* chore: link-check

* chore: use test url

* chore: link check

* chore: remove unused assets, fix:icon

* chore: version & style

* chore: font feeling

* chore: version, components

* chore: missing icons, ts errors

* chore: types

* chore: remove unused things 1

* chore: unused modules, scroll to top

* chore: doc

* chore: remove images

* chore: plugins

* fix: search result for doc

* fix: header, code block, styles

* fix: unresponsive parts

* fix: header color on home

* chore: use case instead of fetures

* fix: scrolling and offset issue

* chore: yarn lock

* chore: package

* fix: icons

* Add .circleci/config.yml

* chore: test, misc issues

* chore: format 1

* chore: gatsby-plugin-twitter

* chore: sass plugin & style

* chore: lint-css

* chore: ts-lint

* fix: refect prev pr's change

Co-authored-by: Ivan Shcheklein <[email protected]>
  • Loading branch information
charnysh-dev and shcheklein authored Jul 12, 2021
1 parent 054df20 commit d2cef2b
Show file tree
Hide file tree
Showing 282 changed files with 16,884 additions and 8,436 deletions.
81 changes: 81 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Javascript Node CircleCI 2.0 configuration file
#
# See https://circleci.com/docs/2.0/language-javascript/ for more details.
#
version: 2.1

defaults: &defaults
working_directory: ~/repo
docker:
# Specify the version you desire here.
- image: circleci/node:12

# Specify service dependencies here if necessary.
# CircleCI maintains a library of pre-built images,
# documented in https://circleci.com/docs/2.0/circleci-images/

commands:
install:
steps:
- checkout

# CircleCI breaks master branch which affects format check below. See
# https://discuss.circleci.com/t/checkout-script-adds-commits-to-master-from-circle-branch/14194
- run:
name: restore master
command: |
git checkout master
git reset --hard origin/master
git checkout -
# Download cached dependencies.
- restore_cache:
keys:
- v2-dependencies-{{ checksum "yarn.lock" }}
# Fallback to using the latest cache if no exact match is found.
- v2-dependencies-

- run: yarn

# Upload dependencies cache.
- save_cache:
paths:
- node_modules
key: v2-dependencies-{{ checksum "yarn.lock" }}

jobs:
test:
<<: *defaults
steps:
- install
- run: yarn test
- run: yarn lint-css
- run: yarn lint-ts
- run: yarn format-check

test_full:
<<: *defaults
steps:
- install
- run: yarn test
- run: yarn lint-css
- run: yarn lint-ts
- run: yarn format-check

workflows:
version: 2

commit:
jobs:
- test

daily:
triggers:
- schedule:
cron: '0 0 * * *'
filters:
branches:
only:
- master
jobs:
- test_full
4 changes: 4 additions & 0 deletions .codeclimate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"version": "2",
"exclude_patterns": ["**/*.test.js", "**/node_modules/"]
}
5 changes: 1 addition & 4 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,2 @@
.cache
package.json
package-lock.json
public
storybook-static*
.cache
24 changes: 0 additions & 24 deletions .eslintrc

This file was deleted.

52 changes: 52 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
{
"extends": [
"plugin:react/recommended",
"plugin:@typescript-eslint/recommended",
"prettier/@typescript-eslint",
"plugin:prettier/recommended",
"plugin:jsx-a11y/recommended",
"plugin:json/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaFeatures": {
"jsx": true
}
},
"env": {
"browser": true,
"jest": true
},
"settings": {
"react": {
"version": "detect"
}
},
"rules": {
"@typescript-eslint/interface-name-prefix": [
"error",
{ "prefixWithI": "always" }
],
"no-tabs": "error",
"react/prop-types": "off",
"@typescript-eslint/no-unused-vars": "error"
},
"overrides": [
{
"files": [
"src/utils/shared/*.?(js|ts)",
"src/gatsby/**/*.js",
"src/components/PageWrapper/index.js",
"scripts/**/*.js",
"config/**/*.js",
"src/server/**/*.js",
"gatsby-*.js",
"postcss.config.js"
],
"rules": {
"@typescript-eslint/no-var-requires": "off",
"@typescript-eslint/explicit-function-return-type": "off"
}
}
]
}
2 changes: 2 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
**Please see our contributing guide at
[dvc.org](https://dvc.org/doc/user-guide/contributing/docs).**
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: Bug or improvement report
about: Create a report to help us improve
---
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
name: Feature request
about: Suggest an idea for this project
---
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
> You may disregard these recommendations if you used the **Edit on GitHub** button from dvc.org to improve a doc in place.
❗ Please read the guidelines in the [Contributing to the Documentation](https://dvc.org/doc/user-guide/contributing/docs) list if you make any substantial changes to the documentation or JS engine.

🐛 Please make sure to mention `Fix #issue` (if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.

Please choose to [allow us](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to edit your branch when creating the PR.

Thank you for the contribution - we'll try to review it as soon as possible. 🙏
21 changes: 21 additions & 0 deletions .github/workflows/link-check-all.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Check all links in the repository
on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'

jobs:
run:
name: Link Check All
runs-on: ubuntu-latest
env:
NODE_OPTIONS: '--max-http-header-size=65536'

steps:
- uses: actions/checkout@v2

- name: Run Link Check
uses: 'iterative/[email protected]'
with:
configFile: 'config/link-check/config.yml'
output: consoleLog
50 changes: 50 additions & 0 deletions .github/workflows/link-check-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
name: Check new links against deployment
# This workflow "triggers" and skips on deployment because GitHub Actions /
# Checks refuses to show the check on deployment_status
on:
- deployment
- deployment_status

jobs:
run:
name: Initialize
runs-on: ubuntu-latest
if: github.event.deployment.ref != 'master' && github.event.deployment_status.state == 'success'

steps:
- uses: actions/checkout@v2

- id: build_check
uses: LouisBrunner/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
name: Report
status: queued

- name: Run Link Check
id: check
uses: 'iterative/[email protected]'
with:
diff: true
configFile: 'config/link-check/config.yml'
rootURL: '${{ github.event.deployment.payload.web_url }}'
output: checksAction

- uses: LouisBrunner/[email protected]
if: ${{ success() }}
with:
token: ${{ secrets.GITHUB_TOKEN }}
check_id: ${{ steps.build_check.outputs.check_id }}
status: completed
conclusion: ${{ steps.check.outputs.conclusion }}
output: ${{ steps.check.outputs.output }}

- uses: LouisBrunner/[email protected]
if: ${{ failure() }}
with:
token: ${{ secrets.GITHUB_TOKEN }}
check_id: ${{ steps.build_check.outputs.check_id }}
status: completed
conclusion: failure
output: >-
{"summary": "The Link Check script had an error!"}
37 changes: 19 additions & 18 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@ lib-cov
# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

Expand All @@ -29,14 +26,14 @@ bower_components
# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Typescript v1 declaration files
# TypeScript v1 declaration files
typings/

# Optional npm cache directory
Expand All @@ -51,21 +48,25 @@ typings/
# Output of 'npm pack'
*.tgz

# dotenv environment variable files
.env*
# Yarn Integrity file
.yarn-integrity

# gatsby files
.cache/
public
# dotenv environment variables file
.env

# Mac files
# Editors & logs
*.log
.idea
.vscode
.history

# Mac finder artifacts
.DS_Store

# Yarn
yarn-error.log
.pnp/
.pnp.js
# Yarn Integrity file
.yarn-integrity
# Gatsby cache
.cache
public
tmp

storybook-static
# Copied 404 for Heroku
404.html
1 change: 0 additions & 1 deletion .node-version

This file was deleted.

6 changes: 6 additions & 0 deletions .pre-commit-hooks.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
- id: dead-url
name: Dead URL Checker
entry: scripts/link-check.sh
language: script
types: [text]
description: This hook searches for problematic URLs.
9 changes: 4 additions & 5 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
.cache
package.json
package-lock.json
public
storybook-static*
.cache/
.github
public/
src/components/pages/Home/UseCasesSection/index.tsx
8 changes: 7 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
{
"semi": false,
"arrowParens": "avoid",
"semi": false
"singleQuote": true,
"trailingComma": "none",
"printWidth": 80,
"tabWidth": 2,
"useTabs": false,
"proseWrap": "always"
}
19 changes: 19 additions & 0 deletions .restyled.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
restylers:
- name: prettier
arguments:
[
'--write',
'--trailing-comma=none',
'--no-semi',
'--arrow-parens=avoid',
'--single-quote=true',
'--print-width=80',
'--tab-width=2',
'--use-tabs=false',
'--prose-wrap=always',
]
include:
- './*.{js,md}'
- 'pages/**/*.js'
- 'content/**/*.md'
- 'src/**/*.js'
Loading

0 comments on commit d2cef2b

Please sign in to comment.