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

Make README more user friendly, and less dependent on domain knowledge #216

Closed
kevin-kline opened this issue Aug 13, 2021 · 2 comments
Closed
Assignees
Labels
type/feature-request This issue is a proposal for something new

Comments

@kevin-kline
Copy link
Contributor

kevin-kline commented Aug 13, 2021

Here is a suggestion for substitution our current "User Setup" section:

User Setup

NOTE: If you only plan to run the product, this is the only section you should need

  1. Clone this repository

    git clone https://github.com/merico-dev/lake.git
    cd lake
  2. Create a copy of the sample configuration files with

    cp config/docker.sample.js config/docker.js
    cp config/plugins.sample.js config/plugins.js
    
  1. Get tokens for the data sources you want to pull from

Data Sources we Currently Support:

....insert data source chart....

For example, if you want to get an API token from GitLab, follow these directions:

gitlab

  1. Open your favourite IDE to start editing files

  2. Find the plugin config file that we just created (config/plugins.js)

  3. Replace the "token" fields with the tokens you created in step 3

NOTE: For more info on plugin configuration, please see: data-source

  1. Start the service with npm start

    you can stop all docker containers with npm run stop

  2. Run docker-compose logs -f lake to check the logs and see when lake stops collecting your data. This can take up to 20 minutes for large projects. (gitlab 10k+ commits or jira 5k+ issues)

  3. Navigate to Grafana Dashboard https://localhost:3002 (Username: admin, password: admin)

@kevin-kline kevin-kline added the type/feature-request This issue is a proposal for something new label Aug 13, 2021
@kevin-kline
Copy link
Contributor Author

This is needed unless we change to a programmatic configuration prompt system:

#212

@joncodo
Copy link
Contributor

joncodo commented Aug 17, 2021

We ended up doing programatic configuration with npm run configure. Since we are doing this, this ticket is no longer needed. Feel free to re-open it. :)

@joncodo joncodo closed this as completed Aug 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/feature-request This issue is a proposal for something new
Projects
None yet
Development

No branches or pull requests

3 participants