Skip to content

Commit

Permalink
Move docusaurus to root, remove unneeded files. (#83)
Browse files Browse the repository at this point in the history
Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri authored Sep 20, 2023
1 parent d1a7077 commit e867a07
Show file tree
Hide file tree
Showing 205 changed files with 12,787 additions and 514 deletions.
38 changes: 28 additions & 10 deletions .gitignore
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/
461 changes: 0 additions & 461 deletions .idea/dbnavigator.xml

This file was deleted.

3 changes: 0 additions & 3 deletions .vscode/settings.json

This file was deleted.

39 changes: 2 additions & 37 deletions README.md
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.
Loading

0 comments on commit e867a07

Please sign in to comment.