"import" the adaptor/wiki content into the Docs site
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 23
- Forks
- 20
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 6
Description
Right now, our way of providing the brightest and best advice and guidance on Contributing to the Open Source Project, is via @josephjclark and others updating the MD Files in here: https://github.com/OpenFn/adaptors/tree/main/wiki
Previously we have directed people towards this Wiki, but that is now out of date and most of the content has been moved.
For this Issue, we want to surface the latest and greatest guidance on building Adaptors in the 'Contribution' part of the Docs Site. So, within the 'Contribute' section of the Docs Site, there should be a new 'Adaptors' section. Within that, there should be:
That section should be made up of several sub-sections:
- A landing page named 'Adaptors 101' which should pull the latest content from the 'Introduction' page on the Adaptors docs here: https://docs.openfn.org/adaptors
- Then for each of the below, they should populate with the latest content from the md files stored in the following links on Github:
Build a new Adaptor
Useful Commands
Best Practice
Documentation Guide
FHIR Adaptors
Magic Functions
Unit Test Guide
Acceptance Criteria
GIVEN I am looking at the 'Contribute' section of the Docs Site
WHEN I expand that section
THEN I should see a new section called 'Adaptors'
GIVEN I can see the 'Adaptors' section
WHEN I expand that section
THEN I should see all the sections listed in this ticke: Build a new Adaptor; Useful Commands; Best Practice; Documentation Guide; FHIR Adaptors; Magic Functions; Unit Test Guide
GIVEN I can see all of those sections
WHEN I click into them
THEN I should see the latest version of the content stored in the md files here https://github.com/OpenFn/adaptors/blob/main/wiki/index.md
AND if an update is made to any of those files
THEN I should see those updates reflected in the latest version of the Docs site
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Docs site's Contribute section and inspect how its navigation and content pages are defined. Compare the requested pages with wiki/build-a-new-adaptor.md, wiki/commands.md, wiki/best-practice.md, docs.md, wiki/fhir.md, wiki/magic-functions.md, and wiki/unit-test-guide. Done means the Adaptors section contains all seven pages with current source content and reflects later source updates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100