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

Is new wiki3 ready for prime time? #203

Open
rusefillc opened this issue Jan 23, 2022 · 13 comments
Open

Is new wiki3 ready for prime time? #203

rusefillc opened this issue Jan 23, 2022 · 13 comments

Comments

@rusefillc
Copy link
Contributor

Are there any reason NOT to switch rusefi.com main page links to new wiki?

for instance https://wiki.rusefi.com/Technical/All-Supported-Triggers/ instead of https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers etc etc

@chuckwagoncomputing
Copy link
Member

chuckwagoncomputing commented Jan 23, 2022

In my mind #188 is a pretty big issue.

EDIT: CLOSED

@chuckwagoncomputing
Copy link
Member

Also, lots of pages are missing titles at the top, which is where MkDocs gets its page names.
e.g. https://wiki.rusefi.com/Vaults/Vault-Of-Honda-OEM/ is called "OBD-1" in the search results.

@rusefillc
Copy link
Contributor Author

Sounds like we need to start documenting wiki conventions which are consequences of mkdocs

Just a quick checklist

Realistically we might need automation to validate or even implement "first line of file matches file name" for instance

@chuckwagoncomputing
Copy link
Member

Pages that need to be updated to reflect wiki3:
Build-Server-and-Automation.md
Documentation-Strategy.md
Documentation-Workflow.md
HOWTO/HOWTO-contribute-to-documentation.md

@chuckwagoncomputing
Copy link
Member

#205 When we're ready

@chuckwagoncomputing
Copy link
Member

What are we waiting on at this point?

@rusefillc
Copy link
Contributor Author

@chuckwagoncomputing I do not know :( I am ready when you are ready, I think we've done enough just to start switching.

#208 was the last nail in https://github.com/rusefi/rusefi/wiki value now that we've lost in-place edits https://wiki.rusefi.com/ is clearly in the lead

See also #210

@duhafnusa4
Copy link
Contributor

been a few months. How is the new wiki?

@rusefillc
Copy link
Contributor Author

Open question if #245 is a blocker or not

@mi-hol
Copy link
Contributor

mi-hol commented Nov 13, 2022

Open question if #245 is a blocker or not

not from my view because "search to provide results in optimal order" is a completely different & unrelated topic.
I'd suggest to close this issue.

@rusefillc rusefillc changed the title Is new wiki ready for prime time? Is new wiki3 ready for prime time? Nov 14, 2022
@chuckwagoncomputing
Copy link
Member

I vote that rusefi.com links be switched to wiki.rusefi.com

@mi-hol
Copy link
Contributor

mi-hol commented Mar 24, 2023

I vote that rusefi.com links be switched to wiki.rusefi.com

so do I and would create a PR to close this issue.

Are the files below the only places to require change or do I miss something?
image

image

@chuckwagoncomputing
Copy link
Member

Those need to be switched to links that work in either wiki.
I was talking about links in other places, e.g. TS help links, firmware readmes, the forum and Slack.

https://github.com/search?q=repo%3Arusefi%2Frusefi%20%22github.com%2Frusefi%2Frusefi%2Fwiki%22&type=code

Also, I see that I misspoke myself. What I meant was:
I vote that github.com/rusefi/rusefi/wiki links be switched to wiki.rusefi.com

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

No branches or pull requests

4 participants