openlibhums / openlibhums/memory-alpha

FTP importer docs / general transporter docs

Open
#266 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Markdown
Stars
0
Forks
0
Avg merge
4d 14h
Merged PRs (30d)
2

Description

Content needed

We currently only have:
https://github.com/openlibhums/memory-alpha/blob/b-support-site-mvp/content/pages/support/plugins/production-transporter.md
https://github.com/openlibhums/memory-alpha/blob/b-support-site-mvp/content/pages/support/plugins/discovery-overview.md

Having more than this would be good. Some basic overviews of what they are and can/can't do would be good starts.

If this will sit in dev docs, let me know. I will then update the users docs accordingly.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read content/pages/support/plugins/production-transporter.md and discovery-overview.md first to understand the existing documentation and terminology. Add basic overviews for the FTP importer and other transporters, including what they can and cannot do; done means the main transporter options have useful introductory documentation and the users-docs update can be coordinated.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.