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

[Request] Expose Wiki files to "docs" folder #887

Closed
mlorinc opened this issue Jul 31, 2023 · 3 comments · Fixed by #948
Closed

[Request] Expose Wiki files to "docs" folder #887

mlorinc opened this issue Jul 31, 2023 · 3 comments · Fixed by #948
Assignees
Labels
enhancement New feature or request good-first-issue Good for newcomers
Milestone

Comments

@mlorinc
Copy link
Contributor

mlorinc commented Jul 31, 2023

Only maintainers can see and edit wiki files. So, people outside of Red Hat cannot contribute to wiki at all, which I find unfortunate.

@mlorinc mlorinc added enhancement New feature or request new-issue New issue which was not discussed yet good-first-issue Good for newcomers labels Jul 31, 2023
@djelinek djelinek removed the new-issue New issue which was not discussed yet label Aug 22, 2023
@EcksDy
Copy link
Contributor

EcksDy commented Sep 1, 2023

I see that a lot of the wiki pages are outdated, and wanted to fix some of them as I go along exploring the package.

Is there interest in opening up the wiki to the masses?
Researching on approaches to community docs I've stumbled upon this answer on SO.

I'd be willing to work something along these lines in this repo, using github actions and a wiki/ directory, as docs/ seems to be gitignored for some reason.

@djelinek for visibility 👋

@djelinek
Copy link
Collaborator

djelinek commented Sep 7, 2023

Hello @EcksDy thank you for your interest in this area 🙂 . I would be more than happy if anyone would update documentation and also there is no reason to not expose documentation currently placed at GH Wiki to all contributors.

Did you considered also for example simple usage of GH Pages instead another service?

@EcksDy
Copy link
Contributor

EcksDy commented Sep 8, 2023

@djelinek
My thoughts were to keep things as close to current state as possible, meaning I intended to leave the wiki in the GH Wiki tab.

  • Make a wiki/ dir inside the repo with all wiki markdowns in it
  • Add a job to main.yml workflow called update-wiki that will:
    • Checkout current repo
    • Copy files in wiki/ dir
    • Checkout wiki repo
    • Commit all files in wiki
    • Push to the wiki repo

The job would run only on push to main, since only privileged users can merge to main they should also have access to the wiki repo, so the GH action should hopefully have access too.

I'm not very familiar with how GH pages operate. If you have ideas that can simplify or improve the above plan, let me know and I'll start working in the direction.

@djelinek djelinek linked a pull request Oct 9, 2023 that will close this issue
5 tasks
@djelinek djelinek added this to the 5.10.0 milestone Oct 9, 2023
@djelinek djelinek closed this as completed Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good-first-issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants