-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move docusaurus to root, remove unneeded files. (#83)
Signed-off-by: Mirjam Aulbach <[email protected]>
- Loading branch information
1 parent
d1a7077
commit e867a07
Showing
205 changed files
with
12,787 additions
and
514 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,32 @@ | ||
*build* | ||
.idea/* | ||
kafkawise_docs.egg-info | ||
node_modules | ||
aiven.min.css | ||
# Dependencies | ||
/node_modules | ||
|
||
package-lock.json | ||
node* | ||
*DS_Store* | ||
# Production | ||
/build | ||
|
||
# Generated files | ||
.docusaurus | ||
_website | ||
.cache-loader | ||
|
||
__pycache__ | ||
# Misc | ||
.DS_Store | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
|
||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
|
||
|
||
.DS_STORE | ||
|
||
# IDE/editors | ||
*.sublime-project | ||
*.sublime-workspace | ||
.idea | ||
.idea/ | ||
*.iml | ||
.vscode | ||
.vscode/ |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,3 @@ | ||
# Documentation | ||
# Klaw documentation | ||
|
||
Here is all the information you need to set up and work with this | ||
documentation repository. | ||
|
||
## Get set up | ||
|
||
### Virtualenv (Optional) | ||
|
||
Before installing packages, it is recommended to create a virtualenv. | ||
The command below uses | ||
[virtualenv](https://pypi.org/project/virtualenv/) and the | ||
currently-installed version of Python 3: | ||
|
||
virtualenv --python=$(which python3) v | ||
|
||
Once the virtualenv is created, activate it each time you come to work | ||
on the project: | ||
|
||
. v/bin/activate | ||
|
||
### Install dependencies | ||
|
||
To build and develop custom styles with TailwindCSS (mostly for the | ||
landing page), you will also need Node.js and npm. Install the packages | ||
needed with `npm`: | ||
|
||
npm install | ||
|
||
## Work with docs | ||
|
||
### Build | ||
|
||
npm run build | ||
|
||
### Access docs | ||
|
||
npm start | ||
Here is all the information you need to set up and work with this documentation repository. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.