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

Reflect "wiki edit has to be restricted" facts on relevant wiki article #244

Open
rusefillc opened this issue Nov 8, 2022 · 16 comments
Open
Labels
waiting-on-feedback blocked task, requestor or contributor needs to provide feedback wiki location & process change

Comments

@rusefillc
Copy link
Contributor

@rusefillc
Copy link
Contributor Author

@mi-hol can you please help?

@mck1117
Copy link
Contributor

mck1117 commented Nov 8, 2022

why does that need specific documentation? why not just have instructions for how to contribute to the wiki?

@rusefillc
Copy link
Contributor Author

@mck1117 are you looking to debate or help? Please use your best judgement if you are available to edit any relevant articles/pages.

@rusefillc
Copy link
Contributor Author

Kind of relevant #165 but no idea what action if any is needed. Are we supposed to remember why things are done the way they are done or shall we keep the reasons written down?

@mi-hol
Copy link
Contributor

mi-hol commented Nov 8, 2022

@mi-hol can you please help?

Looking forward to contribute :)

Now a word of caution, I'll try to help, but without having any background I might make wrong assumptions or even upset a valued contributor.
Please bare with me and assume that I want to help with the best of my (limited) understanding.
Please consider that my native language is German and things are expressed very differently in English.
I prefer to get direct and honest feedback and can withstand a "no" but might ask for the reasoning to be explained in order to improve my understanding.

@mi-hol
Copy link
Contributor

mi-hol commented Nov 13, 2022

why not just have instructions for how to contribute to the wiki?

From my view this is the right approach but it moves the burden on to reviewers to only merge appropriate changes.
Defining review rules would allow for (partial) automation.
As example a rule like:

  • enforce 4 eyes principle, author of change and person that merges a change can't be the same?

Suggestions very welcome

@rusefillc
Copy link
Contributor Author

I am sorry I am barely engaging for multiple reasons :(

@mi-hol
Copy link
Contributor

mi-hol commented Nov 13, 2022

I am barely engaging for multiple reasons

is this due to "Andrey does not believe in text documentation on wiki" as mentioned in https://wiki.rusefi.com/Documentation-Strategy/ ?

@rusefillc
Copy link
Contributor Author

Yes that's one of the reasons

rusefi/rusefi#4722 for instance is much higher priority

@mi-hol
Copy link
Contributor

mi-hol commented Nov 13, 2022

During my career as developer I had to learn the following principle in order to be successful and have time for new development.
The principles:

DRY means "Don't Repeat Yourself"
So when a piece of software was deployed its users came back with questions. Usually after a short period of the time the same questions came up again and again.
My strategy to have still time for new development was let users become experts for the piece of software themself by first asking: "Have you RTFM?"

RTFM means "Read The Fine Manual" obviously this required to create a manual during mainly the test phase of development too. And to update it when I would have provided an answer repeatedly.

@rusefillc
Copy link
Contributor Author

I think we have agree on the principle see https://github.com/rusefi/rusefi/wiki/Contributors-please-work-smart

We are chatting via github which is not effective.

@mi-hol
Copy link
Contributor

mi-hol commented Jan 27, 2023

@rusefillc this seems the last part to be documented before issue can be closed.

  1. Topic I plan to add are:
  • role of doc-team
  • how to join doc-team
  • how to leave doc-team

Any other topics missing?

  1. I tried to get feedback from this team but only you and David ever replied.
    Should we remove "inactive" team members?

@mi-hol mi-hol added the needs-more-info requestor or contributor needs to provide feedback label Jan 27, 2023
@rusefillc
Copy link
Contributor Author

In my opinion we are too far in the wrong area of "content/progress made" (low) and process/policy/cleanup

As of Jan 2023 rusEFI is at least stagnating if not dead. I am excited to play with my test mules and make some progress in a few areas, I am absolutely not excited about process/policy/cleanup.

@rusefillc rusefillc removed their assignment Jan 28, 2023
@rusefillc rusefillc removed the needs-more-info requestor or contributor needs to provide feedback label Jan 28, 2023
@mi-hol
Copy link
Contributor

mi-hol commented Jan 28, 2023

the frustration expressed should be discussed in a talk

@mi-hol
Copy link
Contributor

mi-hol commented Jan 31, 2023

as explained here this issue is blocked by a lacking decision from architect

@mi-hol mi-hol added the waiting-on-feedback blocked task, requestor or contributor needs to provide feedback label Jan 31, 2023
@mi-hol
Copy link
Contributor

mi-hol commented Mar 9, 2023

Because of " I am absolutely not excited about process/policy/cleanup. " I'm removing myself from this topic

@mi-hol mi-hol removed their assignment Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
waiting-on-feedback blocked task, requestor or contributor needs to provide feedback wiki location & process change
Projects
None yet
Development

No branches or pull requests

3 participants