Skip to content

Move patterns from the wiki to markdown files in the repo #132

New issue
New issue
Closed
Closed
Move patterns from the wiki to markdown files in the repo#132
Labels
Type - Maintenance / CleanupMaintaining / cleaning the repo is the main focus of this issue / PR

Description

@spier
spier
opened on Mar 18, 2020

Currently we have patterns in various places:

  • markdown (.md) files in the repo (true for most of the Proven/Reviewed patterns)
  • gDocs
  • wiki of this repo

There are some challenges with this:

a) it is harder to find the patterns (as one has to look in multiple places)
b) providing feedback for the patterns in the wiki is not possible (as the wiki does not get forked together with the rest of the repo)
c) providing feedback for the patterns in gDocs might not always be possible (depending on how the owner of the gDoc has set the permissions)

Therefore I propose to move all patterns to the repo, irrespective of the Maturity or Review Step they are in.

This change will empower all contributors to use the same contribution process for any pattern i.e. fork + edit + pull request.

To slice the problem a bit smaller, I suggest to start by moving the patterns from the wiki to markdown files in the repo.

References

mini discussion in Slack

Activity

  1. spier commented on Mar 18, 2020

    @spier
    spier
    on Mar 18, 2020
    MemberAuthor

    Links to the wiki:

    $ grep "innersourcecommons.org/wiki" README.md
* [Overcome Acquisition Based Silos - Developers](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Overcome-Acquisition-based-Silos)
* [Overcome Acquisition Based Silos - Managers](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Overcome-Acquisition-based-Silos)
* [Shared Code Repo Different from Build Repo](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Shared-Code-Repo-Different-from-Build-Repo) - *Deal with the overhead of having shared code in a separate repository that isn't the same as the project-specific one that is tied to production builds.*
* [Incentive Alignment](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut:-Creating-Developer-Incentive-Alignment-for-InnerSource-Contribution)
* [Change the Developers Mindset](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Pattern:-change-the-developers-mindset)
* [Share Your Code to Get More Done - Likely Contributors Variant](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Pattern:-Share-Your-Code-to-Get-More-Done---Likely-Contributors-Variant)
* [Donut 3: How to Defeat the Hierarchical Constraints](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut-3%3A-how-to-defeat-the-hierarchical-constraints)
* [Donut 5: Project Management Time Pressures](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut-5:-project-management-time-pressures)
* [Donut 6: Organizational Mindset Change](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut-6:-organizational-mindset-change)
* [Donut 8: Not Invented Here](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut-8:-Not-invented-here)
* [Donut: Bad Weather For Liftoff](https://github.com/InnerSourceCommons/innersourcecommons.org/wiki/Donut:-Bad-weather-for-liftoff)

  2. rrrutledge commented on Mar 18, 2020

    @rrrutledge
    rrrutledge
    on Mar 18, 2020
    Contributor

    Let's do it. Sounds great!

  3. lenucksi
    added
    Type - Maintenance / CleanupMaintaining / cleaning the repo is the main focus of this issue / PR
    on Mar 22, 2020

  4. spier commented on Apr 10, 2020

    @spier
    spier
    on Apr 10, 2020
    MemberAuthor

    In #134 we ported a first set of wiki pages from innersourcecommons.org/wiki to InnerSourcePatterns (this repo).

    In InnerSourceCommons/innersourcecommons.org#134 those ported wiki pages should get deleted. (By chance it is issue number 134 in both repos. Don't get confused here :))

    Once that is done, I suggest to go through the rest of the innersourcecommons.org/wiki and port all remaining patterns into the InnerSourcePatterns repo.

    To summarize the next steps again:

  5. lenucksi commented on Apr 25, 2020

    @lenucksi
    lenucksi
    on Apr 25, 2020
    Member

    Deleted the pages mentioned in InnerSourceCommons/innersourcecommons.org#134

  6. spier commented on Apr 25, 2020

    @spier
    spier
    on Apr 25, 2020
    MemberAuthor

    @lenucksi I checked, and could not find any other Patterns there that can be ported.

    However I found more things that can be cleaned up in the wiki innersourcecommons.org/wiki.

    Posted it here to save myself some time.

    Patterns already ported to repo

    Non-patterns pages that are no longer needed

  7. spier commented on Apr 25, 2020

    @spier
    spier
    on Apr 25, 2020
    MemberAuthor

    if you can do those deletions, then we can close this issue here. Nothing else to port from that wiki.

  8. lenucksi commented on Apr 29, 2020

    @lenucksi
    lenucksi
    on Apr 29, 2020
    Member

    if you can do those deletions, then we can close this issue here. Nothing else to port from that wiki.

    All done, closing this.

  9. lenucksi
    closed this as completedon Apr 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

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

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions