Skip to content

MAJOR BUG trigger page is broken #291

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

Closed
rusefillc opened this issue Dec 16, 2022 · 10 comments
Closed

MAJOR BUG trigger page is broken #291

rusefillc opened this issue Dec 16, 2022 · 10 comments

Comments

@rusefillc
Copy link
Contributor

rusefillc commented Dec 16, 2022

https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers is one of the most important rusEFI documentation pages

At the moment it does not display images
I believe it was displyaing images a few days ago

ALL ACTIVITY HAS TO HALT UNTIL WE INVESTIGATE HOW DID WE ALLOW https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers to break

@chuckwagoncomputing
Copy link
Member

This is more Github trailing slash buggery that we have no power over. Let's move to a wiki that we do have power over.

@mi-hol
Copy link
Contributor

mi-hol commented Dec 16, 2022

HOW DID WE ALLOW https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers to break

from my view the root cause lies in /rusefi_documentation/.github/workflows/sync-wiki.yaml

  - name: Generate static pages using mkdocs
      run: |
        shopt -s extglob
        cd mkdocs
        mkdir docs
        cp -r ../!(mkdocs) docs
        mkdocs build
  • seems to use a "default" configuration of mkdocs
  • misses to check for result of build
  • no tests to verify correctness of key files are performed
  • but the next step "Upload static results to wiki3" publishes result directly

@rusefillc
Copy link
Contributor Author

I do not follow

https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers is source, not result of mkdocs process

@rusefillc
Copy link
Contributor Author

While it's source it's also PRIMARY instance

I.e. we stumble over ourselves in terms of how to implement the transition

@chuckwagoncomputing
Copy link
Member

  • seems to use a "default" configuration of mkdocs

incorrect, configuration is here

  • misses to check for result of build

  • no tests to verify correctness of key files are performed

  • but the next step "Upload static results to wiki3" publishes result directly

Yep, that's some very poor engineering on my part.


HOWEVER - MkDocs has nothing to with the issue at hand.

@mi-hol
Copy link
Contributor

mi-hol commented Dec 16, 2022

I do not follow
https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers is source,

I have edited /rusefi/rusefi_documentation/Technical/All-Supported-Triggers.md to fix link issues (see PR #273 related to issue
#123)
"source" implies this should not have been done.
If I understand this correctly, the only safe way to prevent such an unintentional "error" would be:

  • the file should not exist at all

OR

  • be protected from edits.

@rusefillc
Copy link
Contributor Author

https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers is the URL which I would prefer to absolutely work.

https://github.com/rusefi/rusefi_documentation/blob/master/Technical/All-Supported-Triggers.md is an exact clone on the file which would be displayed on https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers

Meaning that any edits to https://github.com/rusefi/rusefi_documentation/blob/master/Technical/All-Supported-Triggers.md have to account for the fact that it's exactly the file which has to be working properly at https://github.com/rusefi/rusefi/wiki/All-Supported-Triggers

Good news we have #293

@chuckwagoncomputing
Copy link
Member

I opened a ticket with Github 9 days ago re. trailing slashes, and have received no response. I think Github doesn't care.

@rusefillc
Copy link
Contributor Author

@chuckwagoncomputing ticket URL please?

anyway we've fixed triggers catalog so closing this ticket

@chuckwagoncomputing
Copy link
Member

@rusefillc It's a non-public Github support ticket.

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

3 participants