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

Flat .md structure as a way to reduce migration pain/consistency #293

Closed
rusefillc opened this issue Dec 17, 2022 · 7 comments
Closed

Flat .md structure as a way to reduce migration pain/consistency #293

rusefillc opened this issue Dec 17, 2022 · 7 comments

Comments

@rusefillc
Copy link
Contributor

For instance https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers is made out of https://github.com/rusefi/rusefi_documentation/blob/master/Technical/All-Supported-Triggers.md - note how "Technical" disappears

Looks like to survive all the three wikis mess we would have to move all .md folders into root folder

This seems to be at least part of the of #291 maybe #292 else

@mi-hol
Copy link
Contributor

mi-hol commented Dec 17, 2022

Sorry but this approach suits only as a temporary workaround for one single file because document editor's experience is still broken!
We need a solution that works for all involved parties.

image

@mi-hol mi-hol mentioned this issue Dec 17, 2022
@chuckwagoncomputing
Copy link
Member

I hate flat directory structures, but it appears this is the only way to make Github wiki actually work.

@mi-hol Unfortunately whatever tool you are using there doesn't understand how Github wiki works, and that's not our fault. Maybe you should open a feature request with whoever has made it?
Links and images that actually work are a high priority.

@rusefillc
Copy link
Contributor Author

just moved 129 .md files manually there is a good chance I've missed some

Need help locating what have I missed? Might be a one line bash?

@chuckwagoncomputing
Copy link
Member

From memory:
find */* -name '*.md' -exec mv '{}' . \;
Not near a computer so I'm not sure if this is right, but it's close.

@chuckwagoncomputing
Copy link
Member

Looks like that command works, but beware of name collisions - there are three files named readme.md. Rename them before running the command.
Also, you can run find . -type d -empty to find directories that are left empty.

@rusefillc
Copy link
Contributor Author

Collisions commit was cherry picked into master c425e81

@rusefillc
Copy link
Contributor Author

thank you @chuckwagoncomputing all moved now, we are flat with .md, closing

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

No branches or pull requests

3 participants