Skip to content
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

Add document website #604

Merged
merged 10 commits into from
Jun 9, 2020
Merged

Add document website #604

merged 10 commits into from
Jun 9, 2020

Conversation

cwen0
Copy link
Member

@cwen0 cwen0 commented Jun 8, 2020

What problem does this PR solve?

What is changed and how does it work?

Check List

Tests

  • Unit test
  • E2E test
  • Manual test (add detailed scripts or steps below)

image
image
image

@codecov-commenter
Copy link

codecov-commenter commented Jun 8, 2020

Codecov Report

Merging #604 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #604   +/-   ##
=======================================
  Coverage   55.78%   55.78%           
=======================================
  Files          68       68           
  Lines        4383     4383           
=======================================
  Hits         2445     2445           
  Misses       1768     1768           
  Partials      170      170           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8f5b008...a8f3420. Read the comment docs.

yeya24
yeya24 previously approved these changes Jun 8, 2020
Copy link
Contributor

@yeya24 yeya24 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! A small question here:

Is it possible to make the blog title font size smaller?

Screenshot from 2020-06-08 12-37-22

Can we make the content wider?

Screenshot from 2020-06-08 12-37-35

Signed-off-by: cwen0 <[email protected]>
Signed-off-by: cwen0 <[email protected]>
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} PingCAP, Inc. Built with Docusaurus.`,
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'template literal syntax' is only available in ES6 (use 'esversion: 6').

description="Description will go into a meta tag in <head />">
<header className={classnames('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclosed regular expression.
Unrecoverable syntax error. (32% scanned).

import CodeSnippet from "@site/src/theme/CodeSnippet";

const install = `# Install on Kubernetes
curl -sSL https://raw.githubusercontent.com/pingcap/chaos-mesh/master/install.sh | sh`
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing semicolon.

Signed-off-by: cwen0 <[email protected]>
description="Description will go into a meta tag in <head />">
<header className={classnames('hero hero--primary', styles.heroBanner)}>
<div className="container">
<h1 className="hero__title">{siteConfig.title}</h1>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclosed regular expression.
Unrecoverable syntax error. (33% scanned).

Signed-off-by: cwen0 <[email protected]>
@cwen0
Copy link
Member Author

cwen0 commented Jun 9, 2020

Great work! A small question here:

Is it possible to make the blog title font size smaller?

Screenshot from 2020-06-08 12-37-22

Can we make the content wider?

Screenshot from 2020-06-08 12-37-35

Good suggestion! At present, this is designed by the theme that we used. In the future, we will develop a new theme design for us.

website/README.md Outdated Show resolved Hide resolved
@yeya24
Copy link
Contributor

yeya24 commented Jun 9, 2020

Great work! A small question here:
Is it possible to make the blog title font size smaller?
Screenshot from 2020-06-08 12-37-22
Can we make the content wider?
Screenshot from 2020-06-08 12-37-35

Good suggestion! At present, this is designed by the theme that we used. In the future, we will develop a new theme design for us.

You mean we will develop the theme ourselves? 😄

@cwen0
Copy link
Member Author

cwen0 commented Jun 9, 2020

Great work! A small question here:
Is it possible to make the blog title font size smaller?
Screenshot from 2020-06-08 12-37-22
Can we make the content wider?
Screenshot from 2020-06-08 12-37-35

Good suggestion! At present, this is designed by the theme that we used. In the future, we will develop a new theme design for us.

You mean we will develop the theme ourselves? 😄

We just need to update the style and the layout. Not a new one.

cwen0 added 2 commits June 9, 2020 20:34
Signed-off-by: cwen0 <[email protected]>
Signed-off-by: cwen0 <[email protected]>
{line.map((token, key) => (
<span {...getTokenProps({ token, key })} />
))}
</div>
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unclosed regular expression.
Unrecoverable syntax error. (83% scanned).

Copy link
Member

@fewdan fewdan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@fewdan
Copy link
Member

fewdan commented Jun 9, 2020

/merge

@sre-bot
Copy link
Contributor

sre-bot commented Jun 9, 2020

/run-all-tests

@sre-bot sre-bot merged commit 1c83efd into chaos-mesh:master Jun 9, 2020
@cwen0 cwen0 deleted the add_website branch June 9, 2020 14:11
themeConfig: {
defaultDarkMode: false,
algolia: {
apiKey: '1d330c3dae1c5376607ecee61b4e2271',

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it safe to make it public?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the public API key to use in frontend code and Search-Only.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it. Thanks @cwen0

shonge pushed a commit to shonge/chaos-mesh that referenced this pull request Jul 7, 2020
* init website

Signed-off-by: cwen0 <[email protected]>

* fix comment

Signed-off-by: cwen0 <[email protected]>

* address comment

Signed-off-by: cwen0 <[email protected]>

* update readme

Signed-off-by: cwen0 <[email protected]>

* add CNAME

Signed-off-by: cwen0 <[email protected]>

Co-authored-by: pingcap-github-bot <[email protected]>
Signed-off-by: shonge <[email protected]>
sjwsl pushed a commit to sjwsl/chaos-mesh that referenced this pull request May 6, 2021
* init website

Signed-off-by: cwen0 <[email protected]>

* fix comment

Signed-off-by: cwen0 <[email protected]>

* address comment

Signed-off-by: cwen0 <[email protected]>

* update readme

Signed-off-by: cwen0 <[email protected]>

* add CNAME

Signed-off-by: cwen0 <[email protected]>

Co-authored-by: pingcap-github-bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants