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

Move procedural docs to wiki #4861

Closed
ghost opened this issue Jan 6, 2021 · 11 comments
Closed

Move procedural docs to wiki #4861

ghost opened this issue Jan 6, 2021 · 11 comments

Comments

@ghost
Copy link

ghost commented Jan 6, 2021

This (backdrop-issues) repository stores a folder of Procedural Documents which are markdown files that explain how to do various things in GitHub, etc.

In #4859 it was briefly discussed whether these documents would be better stored in this repository's Wiki instead.

I'm opening this issue to discuss moving the documents from code to the wiki.

I personally think the wiki makes more sense. Interested to hear others' thoughts...

@indigoxela
Copy link
Member

I think, wiki pages are searchable. That might be a benefit.

@ghost
Copy link
Author

ghost commented Jan 6, 2021

And I think they're easier to navigate (menu of pages on the side, etc.).

@stpaultim
Copy link
Member

This makes sense to me.

@ghost
Copy link
Author

ghost commented Feb 10, 2023

I wonder if it'd be better to use the core repo's wiki instead...? Or perhaps https://github.com/backdrop-ops/backdrop-community Neither wikis are enabled yet, but that's easy to do.

Considerations:

  • Who has access to edit wiki pages?
  • Where does it make sense to put these pages?

Either way, we could copy the page contents to the new wiki, then update the issue repo pages to link to their new location. Then down the track we can delete the issue repo pages altogether.

@jenlampton
Copy link
Member

My only real concern is for the issue templates that we use for releases. We need to be able to copy/paste those into the issue queue to retain the formatting, and having them in version control is helpful for adding things consistently across all the template options.

Can we keep the issue templates in the repo, but move all the other procedures to wiki?

@ghost
Copy link
Author

ghost commented Feb 10, 2023

Can we keep the issue templates in the repo, but move all the other procedures to wiki?

That seems reasonable. Makes sense to keep issue templates in the issue queue repo :-)

EDIT: To clarify, I believe @jenlampton's referring to these ones:

image

@quicksketch
Copy link
Member

We need to be able to copy/paste those into the issue queue to retain the formatting, and having them in version control is helpful for adding things consistently across all the template options.

Documents in the wiki can be copy/pasted by clicking "Edit" on the page and then copying the content out, like on this page that is already in the wiki:

Peek 2023-02-12 12-09

And the wiki is actually also accessible via Git if you want to clone the entire wiki and work on it locally:

image

@jenlampton
Copy link
Member

Okay, so that eliminates my concerns. :) Is the wiki really a good place for issue templates? (to me it seems like there's no benefit? - but for all the other notes there are.)

@ghost
Copy link
Author

ghost commented Feb 17, 2023

I've moved all procedural docs (other than issue templates) over to the wiki: https://github.com/backdrop/backdrop-issues/wiki

I'll now go and update the repo files to point there temporarily.

EDIT: I really tried to keep the git history, but that doesn't seem to have worked... :-(

@ghost
Copy link
Author

ghost commented Feb 17, 2023

@stpaultim Since the backdrop-issues repository's wiki is now for the procedural docs, can you please move https://github.com/backdrop/backdrop-issues/wiki/New-%22Recipe%22-Project-Type elsewhere? @quicksketch also seemed to be questioning why this was there during today's meeting.

ghost pushed a commit that referenced this issue Feb 17, 2023
@ghost
Copy link
Author

ghost commented Feb 17, 2023

Repo updated now too: e59f05d

I'll close this issue now.

@ghost ghost closed this as completed Feb 17, 2023
@ghost ghost changed the title Move procedural docs to wiki? Move procedural docs to wiki Feb 17, 2023
This issue was closed.
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