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

Wiki can be edited by any user #92

Closed
emagdalenaC2i opened this issue Feb 20, 2020 · 23 comments
Closed

Wiki can be edited by any user #92

emagdalenaC2i opened this issue Feb 20, 2020 · 23 comments
Labels
stale PR/Issue without recent activity, it'll be soon closed automatically.

Comments

@emagdalenaC2i
Copy link

Actually, I just edited it unintentionally.
I expected to receive a warning preventing me from saving the changes, but it was not.

But, I was trying to edit the wiki because I think it can be a good system to record the evolution of module migration. Replacing the migration issues like #75

So, any non-technical user can edit / follow the evolution of the migration.

See https://github.com/OCA/stock-logistics-reporting/wiki

@rousseldenis
Copy link
Sponsor Contributor

Ok, we maybe need to restrict wiki editing to team members.

@OCA/board shouldn't the setting that restrict wiki editing checked by default in all repositories and then let team members decide what to do?

@dreispt
Copy link
Sponsor Member

dreispt commented Feb 20, 2020

My opinion is that it should be kept open, and promote wiki edits to grow an OCA knowledge base.
Wiki is easily accessible to non-technical people, and using Github's one has the advange of keeping code and docs in the same place.

If we have content that rally needs approval before it is changed, we should use repository files for that, so that it need to go through a pull request.

@emagdalenaC2i
Copy link
Author

I am doing some tests and I trully like it. Not only to add information about the repository and the modules but also to move the migration issues to the wiki

As you can see I can revert a commit easily
image

@emagdalenaC2i
Copy link
Author

emagdalenaC2i commented Feb 21, 2020

@mymage
Copy link
Member

mymage commented Feb 21, 2020

I think that keep open the possibility do edit the wiki is a bit hazardous: using team policy isn't only a way to keep out people that eventully haven't good intention (on wiki there isn't a version control to roll back, right?) but it is a step to direct all people contributin to use a common format.

@emagdalenaC2i
Copy link
Author

on wiki there isn't a version control to roll back, right?

Yes, there is. You can also clone the wiki as an usual project
image

@pedrobaeza
Copy link
Member

That's just the opposite of what I want, or bad things will happen:

OCA/oca-github-bot#97 (comment)

@emagdalenaC2i
Copy link
Author

So, should the wikis be restricted to team members? or should be open but focused on documentation?

@pedrobaeza
Copy link
Member

I let that decision to be made, but definitively not for migration issues.

@emagdalenaC2i
Copy link
Author

emagdalenaC2i commented Feb 21, 2020

ok, I agree. If a bot can do a task for me, I am pretty sure it will do that better.
Also the bot will not update the migration issues only every 3 or 4 months

@dreispt
Copy link
Sponsor Member

dreispt commented Feb 21, 2020

This is probably a bad place to discuss this, and is probably a dumb idea, but did you consider generating one issue per module to migrate with a "13.0-MIG" milestone, and then track the milestone?

@simahawk
Copy link

@dreispt I like the idea. It makes easier to handle it w/out complex tools to deal w/ it. PRs can the reference the issue and close it as they are merged.

@pedrobaeza
Copy link
Member

That's going to generate a lot of noise, and most modules doesn't need such discussion. They just need to be migrated.

@simahawk
Copy link

Reported here OCA/oca-github-bot#101

@pedrobaeza I partially agree w/ you. There's a very good part: you leverage GH features and you don't have to maintain a complex script to deal w/ it.

@pedrobaeza
Copy link
Member

It's not a complex script to deal with it... Do you prefer to deal with a repo that will have 100 opened issues for modules that may not be migrated and that complicates any search? Please don't open new battlefields.

@dreispt
Copy link
Sponsor Member

dreispt commented Mar 13, 2020

An Issue is a pending task. If we have 100 issues, it's because there are 100 tasks waiting to be picked up. These are usually good starting points for new contributors.

Honestly, smaller repos will be far from that number.
And on big repos today we already deal with hundreds of open items, and It doesn't seem to be a big deal.

And the upside is that the list of pending + done migration tasks is self updateable.
As a maintainer, it is a waste of my time doing duplicate housekeeping work.
It should be enough to update Tags and Milestones. (Even those may be redundant with proper titles).

@pedrobaeza
Copy link
Member

You will tell me when they get stacked version per version. My vote is negative, the same as in the past with other actions you have taken, but if you want to continue, go ahead, and in the same manner, you will see that they are not effective.

@dreispt
Copy link
Sponsor Member

dreispt commented Mar 13, 2020

It seems that you feel that there will be a accumulation of open migration related issues, and these will be a problem.
I'm sure we're all looking forward to a better way.

What kind of problems do you think these could cause to repo maintainers?
How do you avoid duplicated housekeeping then?
How do you handle later merged modules, that should also be added to the migration list?

@emagdalenaC2i
Copy link
Author

I suposse this is not the only Open source project in which they have this type of issues. How is it managed in other similar projects?

@pedrobaeza
Copy link
Member

@dreispt the ocabot migration commands will allow a better management without that flooding.

@emagdalenaC2i our flow is different from other open source projects where they don't have such parts (modules) to be handled apart.

@dreispt
Copy link
Sponsor Member

dreispt commented Mar 13, 2020

the ocabot migration commands will allow a better management without that flooding.

OK, let's explore that option.
Is there an RFC of PR to have a look at?

@pedrobaeza
Copy link
Member

OCA/oca-github-bot#97

@github-actions
Copy link

github-actions bot commented Dec 5, 2021

There hasn't been any activity on this issue in the past 6 months, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 30 days.
If you want this issue to never become stale, please ask a PSC member to apply the "no stale" label.

@github-actions github-actions bot added the stale PR/Issue without recent activity, it'll be soon closed automatically. label Dec 5, 2021
@github-actions github-actions bot closed this as completed Jan 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale PR/Issue without recent activity, it'll be soon closed automatically.
Projects
None yet
Development

No branches or pull requests

6 participants