npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@devbookhq/docsets-pipeline-manager

v0.0.24

Published

CLI for adding new documentation to Devbook. The CLI command name is `docsets`. You can start documentation scraping and indexing based on configs in the `devbook-docsets` repository with the `create` sub-command. Then you can release documentation that f

Downloads

30

Readme

Docsets Manager

CLI for adding new documentation to Devbook. The CLI command name is docsets. You can start documentation scraping and indexing based on configs in the devbook-docsets repository with the create sub-command. Then you can release documentation that finished scraping and indexing with the release sub-command. If you want to update the documentation with new data, you run the create sub-command again and then update the documentation with the update-release sub-command.

Installation

To install the CLI run the following command:

$ npm i @devbookhq/docsets-pipeline-manager@latest -g --unsafe-perm=true --allow-root

You need to set one environment variable before you use the CLI:

  1. GOOGLE_APPLICATION_CREDENTIALS - location of a JSON containing the GCP service account with permission to access PubSub and Secret Manager.

CLI Usage

How to scrape and index a documentation

The following command starts scraping and indexing documentation defined by configs <configsList...> to the default environment development:

$ docsets create <configsList...>

If you want to use a different environment then use the -e (--env) flag followed by the <env> which is either development or production.

$ docsets create <configsList...> -e <env>

If you want to also deploy VMs for scraping then use the -w (--workers) flag followed by the <workerCount>.

$ docsets create <configsList...> -w <workerCount>

WARNING: VMs created by specifying the CLI flag -w (--workers) are not yet automatically deleted. If you want the VMs deleted, you must do it manually by going to GCP console and deleting all instances named docsets-pipeline-worker-<environment>-<cuid> or by using the gcloud CLI.

If you want to scrape and index a documentation locally you need to have the docsets pipeline running locally and then use the -l (--local) flag.

$ docsets create <configsList...> -l

NOTE: The environment of the local docsets pipeline and the command environment modyfied by the -e (--env) <env> flag must match.

How to release a newly scraped and indexed documentation

The following command starts an interactive prompt for releasing a scraped and indexed documentation to the default environment development.

$ docsets release

If you want to use a different environment then use the -e (--env) flag followed by the <env> which is either development or production.

$ docsets release -e <env>

How to update an existing documentation

The following command starts an interactive prompt for updating a released documentation in the default environment development.

$ docsets update-release

If you want to use a different environment then use the -e (--env) flag followed by the <env> which is either development or production.

$ docsets update-release -e <env>

How to list all scraping and indexing works

The following command starts an interactive prompt for listing all finished, failed, and running works in the default environment development.

$ docsets list

If you want to use a a different environment then use the -e (--env) flag followed by the <env> which is either development or production.

$ docsets list -e <env>

Release

To update the CLI bump the version in package.json and run the following command:

$ npm publish