README updated with new map set-up documentation

[ms0ur1s]

What

Updated README to include the process for creating a new map.

How

Based on my experiences creating the Mesopotamia map with Nick, I documented the process for using the mykomap-site-example repo as the basis for a new, deployable MykoMap.

[wu-lee]

When I try step 3 it doesn't work:

$ git mv mykomap-site-example/ my-new-mykomap/

When I do it literally as written, from my-new-mykomap, I get:

fatal: bad source, source=gitworking/Code-Operative/SEA/my-new-mykomap/mykomap-site-example, destination=gitworking/Code-Operative/SEA/my-new-mykomap/my-new-mykomap/

When I do it from the shared parent directory, I get:

fatal: source directory is empty, source=gitworking/Code-Operative/SEA/mykomap-site-example, destination=gitworking/Code-Operative/SEA/my-new-mmm/mykomap-site-example

I don't know if the git-clone will work as-is either? It might if you're in the parent directory.

This might be how I'd do the job:

# Use the URL from the GitHub repo you want to copy
git clone --depth 1 [email protected]:DigitalCommons/mykomap-site-example.git my-new-mykomap
cd my-new-mykomap

rm -rf .git # blows away the old git database
git init # creates a new one

# commit the files
git add -A
git commit -m "initial commit"

# add back origin/remote (assumes the project has been created)
git remote add origin [email protected]:DigitalCommons/my-new-mykomap
git push --set-upstream origin/master  # (or use origin/main if the project uses that)

(That git remote add command might be equivalent to your set-url version, I didn't check fully)

[ms0ur1s]

Thanks @wu-lee, is it ok for me to create a temporary repo to check the process and update the documentation?

[wu-lee]

@ms0ur1s - I could add in some of these things as part of the work for rolling out the next map. Do you want to respond to anything here, or make any amendments first?

[lin-d-hop]

This is a great issue :)

As a rule of thumb for README bits, let's focus on improvements rather than perfection. READMEs can always be iterated and updated with each new person setting up :)

[lin-d-hop]

@ms0ur1s this issue has been sitting here a while.
Is there a reason you're avoiding it? If so let's figure out how to unblock those reasons.
If the issue is no longer valid then let's close it :)

[ms0ur1s]

Is there a reason you're avoiding it? If so let's figure out how to unblock those reasons. If the issue is no longer valid then let's close it :)

No @lin-d-hop, it's just me putting off the less glamorous work. 😁 I'll make this my first job tomorrow.

Once it's done I'll create a wiki update the README.

[ms0ur1s]

@ms0ur1s - I could add in some of these things as part of the work for rolling out the next map. Do you want to respond to anything here, or make any amendments first?

No, I'm happy with everything you said. Thanks for the help and apologies for not replying earlier. I just keep pushing this ticket just out of sight 😁. I'll do another test set up and add a wiki entry update the README.

[ms0ur1s]

@wu-lee, I've updated the README file, do you mind giving it a once-over?
https://github.com/DigitalCommons/mykomap-site-example/blob/new-map-setup-doc/README.md

Also, do filterable fields still need to be vocabs? If so I'll add this to the documentation.

[wu-lee]

@wu-lee, I've updated the README file, do you mind giving it a once-over? https://github.com/DigitalCommons/mykomap-site-example/blob/new-map-setup-doc/README.md

I gave it a read through - found and fixed a couple of very minor spelling/punctuation things - but otherwise I think as @lin-d-hop says, if there are any more improvements they can be added in the context of future usages of this documentation.

Also, do filterable fields still need to be vocabs? If so I'll add this to the documentation.

Hm, I think they do. This is one thing we want to fix, however - when it gets to the top of the priority queue! So I guess add it, and we can take it out again as part of DigitalCommons/mykomap#201.