Using the wiki #3

ashimokawa commented 2019年06月05日 20:09:41 +02:00

I think we should use the wiki and not README.md or other markdown file in the main repository for documentation.
Wikis can also be accessed via git.

I think we should use the wiki and not README.md or other markdown file in the main repository for documentation. Wikis can also be accessed via git.

buhtz commented 2019年07月09日 14:19:56 +02:00

Conceptual I would agree.

But please see my first try in the Wiki here.

I miss a help-link to see what markdown (dialect) is allowed.
I need a preview button but couldn't find one.
I even do not know how to link one wiki page to another.
How can I create the start/main entry page (clicking on "Wiki")?

It is a mess. https://codeberg.org/Codeberg/Documentation/wiki/Generating-an-SSH-key

Conceptual I would agree. But please see my first try in the Wiki here. I miss a help-link to see what markdown (dialect) is allowed. I need a preview button but couldn't find one. I even do not know how to link one wiki page to another. How can I create the start/main entry page (clicking on "Wiki")? It is a mess. https://codeberg.org/Codeberg/Documentation/wiki/Generating-an-SSH-key

hw commented 2019年07月09日 21:22:31 +02:00

Cool, thank you. The wiki is using plain markdown syntax, every markdown-cheatsheet should help you.

By clicking on the eye in the WYSIWYG editor, wysiwyg vs. markdown source code edit mode is toggled.

Cool, thank you. The wiki is using plain markdown syntax, every markdown-cheatsheet should help you. By clicking on the eye in the WYSIWYG editor, wysiwyg vs. markdown source code edit mode is toggled.

hw commented 2019年07月09日 21:27:37 +02:00

Yes, this works:

$ ssh git@codeberg.org

The result might look like this:

X11 forwarding request failed on channel 0 ## <<-- it is safe to ignore this warning
PTY allocation request failed on channel 0 ## <<-- it is safe to ignore this warning
Hi there, You've successfully authenticated, but Gitea does not provide shell access.
If this is unexpected, please log in with password and setup Gitea under another user.
Connection to codeberg.org closed.

(it is safe to ignore the warnings in the first two lines, these are unavoidable as the git shell does not provide full access even if the user is requesting those features from his git config.)

Yes, this works: ```shell $ ssh git@codeberg.org ``` The result might look like this: ```shell X11 forwarding request failed on channel 0 ## <<-- it is safe to ignore this warning PTY allocation request failed on channel 0 ## <<-- it is safe to ignore this warning Hi there, You've successfully authenticated, but Gitea does not provide shell access. If this is unexpected, please log in with password and setup Gitea under another user. Connection to codeberg.org closed. ``` (it is safe to ignore the warnings in the first two lines, these are unavoidable as the git shell does not provide full access even if the user is requesting those features from his git config.)

buhtz commented 2019年07月09日 23:31:48 +02:00

How can I add an image to the wiki. The image need to be stored somewhere.

How can I add an image to the wiki. The image need to be stored somewhere.

hw commented 2019年07月10日 08:22:01 +02:00

Gitea has several open PRs as work-in-progress to simplify image upload and unify the WYSIWYG toolbar for wiki and issue editor, the two most important ones are probably:

https://github.com/go-gitea/gitea/pull/6024

https://github.com/go-gitea/gitea/issues/6975.

Right now it is possible to upload images via GIT commands (the wiki itself is just a git repository, containing the markdown documents and image files. The latter can now be referenced using their external link). The approach is explained here: https://discourse.gitea.io/t/how-to-add-local-images-to-documentation/899

Gitea has several open PRs as work-in-progress to simplify image upload and unify the WYSIWYG toolbar for wiki and issue editor, the two most important ones are probably: https://github.com/go-gitea/gitea/pull/6024 https://github.com/go-gitea/gitea/issues/6975. Right now it is possible to upload images via GIT commands (the wiki itself is just a git repository, containing the markdown documents and image files. The latter can now be referenced using their external link). The approach is explained here: https://discourse.gitea.io/t/how-to-add-local-images-to-documentation/899

buhtz commented 2019年07月10日 11:16:43 +02:00

I created and pushed pic/dummy.png but do not know how to access it nor how to see it.

tried e.g.

https://codeberg.org/Codeberg/Documentation.wiki/raw/branch/master/pic/dummy.png
https://codeberg.org/Codeberg/Documentation/wiki/pic/dummy.png

I created and pushed `pic/dummy.png` but do not know how to access it nor how to see it. tried e.g. `https://codeberg.org/Codeberg/Documentation.wiki/raw/branch/master/pic/dummy.png` `https://codeberg.org/Codeberg/Documentation/wiki/pic/dummy.png`

hw commented 2019年07月10日 19:23:45 +02:00

It is a bit cumbersome, yes ... let's hope that the abovementioned issues and PRs make good progress. I added this wiki page with an example of a feasible workflow: https://codeberg.org/Codeberg/Documentation/wiki/Including-images-in-wiki-pages

It is a bit cumbersome, yes ... let's hope that the abovementioned issues and PRs make good progress. I added this wiki page with an example of a feasible workflow: https://codeberg.org/Codeberg/Documentation/wiki/Including-images-in-wiki-pages

buhtz commented 2019年07月10日 23:21:17 +02:00

Thanks for the wiki page. Two questions about this.

What is the second "codeberg.png" about? I see no difference when removing it.

Isn't there a way to use sub-folders for pictures? I tried pic/ or ./pic/ and things like that. No success with it.

Thanks for the wiki page. Two questions about this. What is the second `"codeberg.png"` about? I see no difference when removing it. Isn't there a way to use sub-folders for pictures? I tried `pic/` or `./pic/` and things like that. No success with it.

hw commented 2019年07月11日 09:09:12 +02:00

The first image block on the wiki page is just rendering the markdown code as explanation, the second the actual picture. In an actual wiki page, one would only include one image link.

Subfolders are currently not supported in the wiki (there is an open ticket about pictures in subfolders, https://github.com/go-gitea/gitea/issues/4690, generally related to subfolders in wiki is https://github.com/go-gitea/gitea/issues/823, also see the linked issues).

The first image block on the wiki page is just rendering the markdown code as explanation, the second the actual picture. In an actual wiki page, one would only include one image link. Subfolders are currently not supported in the wiki (there is an open ticket about pictures in subfolders, https://github.com/go-gitea/gitea/issues/4690, generally related to subfolders in wiki is https://github.com/go-gitea/gitea/issues/823, also see the linked issues).