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.

Sign up for GitHub

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

Jump to bottom

Add a FAQ in the docs #184

Open
kallewesterling opened this issue May 17, 2023 · 5 comments · May be fixed by #538
Open

Add a FAQ in the docs #184

kallewesterling opened this issue May 17, 2023 · 5 comments · May be fixed by #538
Assignees
@kallewesterling
Labels
enhancement New feature or request new feature

Comments

@kallewesterling
Copy link
Contributor

kallewesterling commented May 17, 2023 •
edited
Loading

Ideas of questions:

  • “Why do I need to patchify my maps?”
  • “Can I generate vector outout?”

Suggested workflow:

  1. Collect potential questions (from internal team, LwM team, and potential users - perhaps even more systematically, with survey or something, including exit tickets or something during the launch event)?
    • Can also drop questions in this issue, below, for later collection
  2. Create a Google Doc where we can start drafting responses.
  3. Create a FAQ page with questions and answers.

Solves the issue of having to answer the same questions repeatedly
@kallewesterling kallewesterling added enhancement New feature or request new feature labels May 17, 2023
@kallewesterling
Copy link
Contributor Author

kallewesterling commented May 17, 2023 •
edited
Loading

Q: Do I need georeferenced maps?

  • MapReader is at its most useful when operating on georeferenced maps.

Q: Do you have good example of maps that I can start working with?

  • OS maps... TNA collections...?

Q: Can the tool download/patchify IIIF maps?*

@rwood-97 rwood-97 assigned rwood-97 and kmcdono2 and unassigned rwood-97 May 24, 2023
@rwood-97
Copy link
Collaborator

  • Use workshop to get a list of FAQs that need answering/adding to the docs

@kallewesterling
Copy link
Contributor Author

Use workshop to get a list of FAQs that need answering/adding to the docs

Great idea!

@rwood-97
Copy link
Collaborator

rwood-97 commented Jun 19, 2023 •
edited
Loading

Q: Do I need cartopy? What does it do in MapReader? What happens if I don't have it?

No - it's optional. Cartopy is used to help plot geospatial data on plots (e.g. via matplotlib) and is used in the plot_metadata_on_map methods of the Download subpackage.
** add example image if you do have it installed and example image for if you don't have it installed**
Everything will work fine if you don't have it.

@kallewesterling kallewesterling moved this to Backlog in MapReader Sep 16, 2024
@kallewesterling
Copy link
Contributor Author

I have collected more questions:

  • is there a GUI?
  • how much technical background do we need to have?
  • what does the output of MapReader look like?
  • how can I contribute to the codebase?
  • can I use MapReader to vectorise maps?
  • is it free to use MapReader?
  • how large do my patches need to be? (i.e. standards? best patch sizes?)
  • what should I use for labels?
  • how can I trust the output from MapReader?

@kallewesterling kallewesterling linked a pull request Dec 10, 2024 that will close this issue
Open
6 tasks
@kallewesterling kallewesterling moved this from Upcoming to In progress (now) in MapReader Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kallewesterling kallewesterling

Labels
enhancement New feature or request new feature
Projects
MapReader
Status: In progress (now)
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adding FAQ to the documentation site maps-as-data/MapReader
3 participants
@kallewesterling @kmcdono2 @rwood-97