Skip to content

Move patterns from wiki to markdown - #134

Merged
lenucksi merged 6 commits into
InnerSourceCommons:masterfrom
spier:issues/132-move-wiki-to-markdown
Mar 27, 2020
Merged

lenucksi merged 6 commits into
InnerSourceCommons:masterfrom
spier:issues/132-move-wiki-to-markdown

Conversation

@spier

@spier spier commented Mar 19, 2020 •

Copy link
Copy Markdown
Member

Implements #132.

What I did:

  • cloned innersourcecommons.org/wiki
  • copied the respective markdown files into the InnerSourcePatterns repo directly
  • shortened the file names, while trying to keep the file names similar to the title of the original wiki pages.
  • adapted the format of the patterns to the format in meta/pattern-template.md
  • linked from each pattern to the original wiki page (we could remove this once the wiki pages get removed)

Suggestions for the reviewer:

  • compare the .md added here to the wiki pages I am linking below, to double check that I did not forget anything
  • some of the filenames are rather long. Maybe we can shorten them? Also I did not know if the files should be named after the solution, or rather after the problem?
  • delete the wiki pages, so that we don't have the same content in two places
  • (possibly later in a new issue) there are some other pages in the wiki that look like patterns but they are not listed in this repo

Block by block, these are the patterns I ported.

Block: "Pattern Drafts (proven, not yet fully reviewed)"

I decided to split this up into two separate pattern files. The original wiki page has some more info than these two markdown files but I did not know what to do with that.

So maybe keep this wiki page around? Not sure.

Block: "Pattern Ideas (not yet proven; brainstormed)"

Block: "Pattern Donuts (needing a solution)".

@spier spier changed the title [WIP] move patterns from wiki to markdown Move patterns from wiki to markdown Mar 21, 2020
@spier
spier marked this pull request as ready for review March 21, 2020 12:23
@lenucksi lenucksi added the Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR label Mar 22, 2020
@maxcapraro

Copy link
Copy Markdown
Member

Thank you for this contribution, @spier 🎉

I think it makes absolute sense to have all pattern content in one place (e.g. not some in the repo, some in a wiki). So imho this can be merged.

I'd like to ask for the advice of our experienced pattern yedi knights first: @NewMexicoKid, @gruetter @StingRayZA was there a reason for not having those patterns in the the repo yet?

@lenucksi lenucksi left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I compared wiki and commit contents and it appears that it's properly moved. I say this LGTM and hence we should merge this.

Re:

  • yes, some filenames are longer. No one died from long filenames yet and we can still rename them later. (my 0,02€)
  • delete wiki pages: yes, please after merging this.
  • follow up on possible pattern content: sounds good. Could you please transform that into an issue with what you've found such that we can handle this later @spier?

@spier

spier commented Mar 28, 2020

Copy link
Copy Markdown
Member Author

Follow-up stories:

@rrrutledge

Copy link
Copy Markdown
Contributor

Nice work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants