docs: remove cost, document missing options and improve docs (#653)

This commit is contained in:
Simon Lecoq
2021-11-04 19:33:29 -04:00
committed by GitHub
parent e147d2ac32
commit a291e35774
56 changed files with 82 additions and 87 deletions

View File

@@ -34,7 +34,9 @@ These are all enabled by default, but you can explicitely opt out from them.
# ... other options
base: header, repositories # Only display "header" and "repositories" sections
repositories: 100 # Query only last 100 repositories
repositories_batch: 25 # Query repositories 25 by 25 (lower this to avoid API timeouts)
repositories_forks: no # Don't include forks
repositories_affiliations: owner, collaborator # Display only repositories where user is owner or collaborator
repositories_skipped: lowlighter/lowlighter # Exclude automatically "lowlighter/lowlighter" repository from plugins allowing a skip list
commits_authoring: octocat@github.com # Handle you use when authoring commits, which can be used to filter commits in other plugins
```

View File

@@ -1,5 +1,4 @@
name: "🗃️ Base content"
cost: 2 GraphQL requests + 1 GraphQL request per 100 repositories fetched
category: core
supports:
- user
@@ -64,7 +63,7 @@ inputs:
type: array
format: comma-separated
default: ""
example: my-repo-1, my-repo-2, owner/repo-3 ...
example: my-repo-1, my-repo-2, owner/repo-3, ...
# List of surnames or email addresses you use when authoring commits
# These are mostly used to perform commits analysis to detect ownership