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

Enable the Wiki #12

Closed
gramakri opened this issue Mar 29, 2019 · 6 comments
Closed

Enable the Wiki #12

gramakri opened this issue Mar 29, 2019 · 6 comments
Labels
type: question Somebody has a question

Comments

@gramakri
Copy link
Contributor

gramakri commented Mar 29, 2019

It looks like the wiki for this repo is disabled or empty? When I click it, nothing happens. Would it be possible to enable it?

Maybe we can just clone https://github.com/hackmdio/codimd.wiki.git and push it here for a start. It has some important pages like https://github.com/hackmdio/codimd/wiki/Environment-Variables

@ccoenen
Copy link
Contributor

ccoenen commented Mar 29, 2019

Thank you for bringing this up! I have to admit that I didn't even remember there were wiki pages in the old repository. We currently have two locations for documentation, apparently. There's also a /docs directory in this repository.

My plan for the next few days would have been to restructure the README anyway. I would also import the previous wiki pages into that docs folder. This will be linked to from the README, so it is as easy to notice as the github wiki.

Would this be satisfactory to you?

@gramakri
Copy link
Contributor Author

@ccoenen Yes, that will be awesome to have them all merged. I don't particularly care if the wiki itself is there or if /docs is used and linked from README as long as the information survives.

@SISheogorath
Copy link
Contributor

I just opened the Wiki for everyone to edit things.

But I would prefer when all documentation will go into ./docs while the wiki can be a community playground. For example to make a list of instances that are out there open for the public (like it existed in the old wiki) as well as tips and tricks on how to use CodiMD :)

Be creative!

@ccoenen
Copy link
Contributor

ccoenen commented Mar 31, 2019

I just merged #15 which brought over all infos from the previous wiki (except the list of instances). The wiki in here has been modified to point to that docs directory.

I would suggest that we use markdown-files in /docs for all things that belong with the code. But if there's anything that would be better held in the wiki (like a list of instances), feel free to add it!

@ccoenen ccoenen closed this as completed Mar 31, 2019
@SISheogorath SISheogorath added the type: question Somebody has a question label Apr 1, 2019
@Perflyst
Copy link

I just opened the Wiki for everyone to edit things.

It is not open for edits (at least I cant edit it). I wanted to transfer the old list from here https://github.com/hackmdio/codimd/wiki/CodiMD-Instances

@ccoenen
Copy link
Contributor

ccoenen commented Jun 29, 2019

there was an additional setting that I didn't know about. It should be editable, now.

restrict wiki access setting

ErikMichelson added a commit that referenced this issue Apr 28, 2024
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
ErikMichelson added a commit that referenced this issue May 9, 2024
Signed-off-by: Erik Michelson <github@erik.michelson.eu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: question Somebody has a question
Projects
None yet
Development

No branches or pull requests

4 participants