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

Add documentation #554

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Conversation

qtomlinson
Copy link
Collaborator

-Add documentation for adding a new harvest source
-Ignore config files in .gitignore

@qtomlinson qtomlinson requested a review from elrayle February 6, 2024 23:31
Copy link
Collaborator

@elrayle elrayle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple of wording suggestions.

docs/add-new-harvester.md Outdated Show resolved Hide resolved
When adding a new harvest source, the points to be considered are located at https://github.com/clearlydefined/clearlydefined/blob/master/docs/adding-sources.md#adding-a-new-harvest-source. Please include these considerations and document them in your GitHub issue, similar to https://github.com/clearlydefined/service/issues/882.

## Crawler
Need to implement:
Copy link
Collaborator

@elrayle elrayle Feb 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Need to implement:
In the crawler, each harvest source must implement fetch and extract functions. The functions are prefixed with a name that identifies the source (e.g. mavenFetch, mavenExtract).
Implement:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants