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

Remove space in image filename and fix markdown and image URLs #6323

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

stweil
Copy link
Member

@stweil stweil commented Nov 22, 2024

Spaces in the names of files or directories are a permanent source of trouble for developers and should therefore be avoided..

Fix also wrong absolute image URLs and buggy markdown titles

Spaces in the names of files or directories are a permanent source
of trouble for developers and should therefore be avoided.

Signed-off-by: Stefan Weil <[email protected]>
@stweil
Copy link
Member Author

stweil commented Nov 22, 2024

Note that index.md contained some more whitespace issues which were automatically fixed by my editor.

@henning-gerhardt
Copy link
Collaborator

If I'm not wrong all the documentation inside the repository is moved to the Wiki pages on GitHub and so this documentation is out of date or at least obsolete. I'm correct @solth ?

@solth
Copy link
Member

solth commented Nov 22, 2024

If I'm not wrong all the documentation inside the repository is moved to the Wiki pages on GitHub and so this documentation is out of date or at least obsolete. I'm correct @solth ?

I think you are correct but for once I would like to pass this question to @matthiaskissler, our documentation manager.

@matthiaskissler
Copy link

Yes, all documentation was moved to Github Wiki; as to the actuality of the documentation (especially the developer part): it would be nice if this could be tested and, if necessary, updated: https://github.com/kitodo/kitodo-production/wiki/Developer-Documentation-Kitodo.Production-3.x

Signed-off-by: Stefan Weil <[email protected]>
Signed-off-by: Stefan Weil <[email protected]>
Signed-off-by: Stefan Weil <[email protected]>
@stweil stweil changed the title Remove space in image filename Remove space in image filename and fix markdown and image URLs Nov 22, 2024
@stweil
Copy link
Member Author

stweil commented Nov 22, 2024

@matthiaskissler, here it is German user documentation. Is such documentation also available somewhere else? And is it really a good idea to separate user documentation from the code on which it depends? How is the documentation synchronized with code changes then? That's very different to developer documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants