Skip to content

Move meta info from main README to /meta #153

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

Merged
merged 2 commits into from
Apr 29, 2020
Merged

Move meta info from main README to /meta #153

merged 2 commits into from
Apr 29, 2020

Conversation

spier
Copy link
Member

@spier spier commented Apr 25, 2020

This PR simplifies the main README.md, by moving the block that is about maintaining the patterns to a meta/README.md.

Also moves pattern-system.md to meta/.

@spier
Copy link
Member Author

spier commented Apr 25, 2020

Alright, so the CODEOWNERS definitely work, given all the automatic review assignments to this PR :)

However the link check is not running automatically. It might only be triggered by a push to master right now actually? Not sure, as I don't know GitHub Actions in that much detail.

Copy link
Collaborator

@NewMexicoKid NewMexicoKid left a comment

Choose a reason for hiding this comment

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

Looks okay. Not 100% convinced that we need to simplify the README (I think it may be more of a personal preference whether to have all the information in a single file or require those who are interested to do a further click), but I'm okay with the proposal.

@spier
Copy link
Member Author

spier commented Apr 26, 2020

Thanks for the feedback @NewMexicoKid and for the approval. I can certainly see that argument for or against multiple READMEs.

I could have explained the purpose of my change better. Let me try:
Right now our main README is the starting point of the ISC Patterns for all users (readers and contributors). You could say the main README is the homepage for ISC Patterns :)

Assuming that the majority of the users will be just readers, I would like to make the main README as simple and short for the readers as possible. The more complicated info is then available for the contributors in a separate place (./meta).

As this is already approved, do you or @lenucksi want to merge this?

@maxcapraro maxcapraro added the Type - Maintenance / Cleanup Maintaining / cleaning the repo is the main focus of this issue / PR label Apr 28, 2020
Copy link
Member

@maxcapraro maxcapraro left a comment

Choose a reason for hiding this comment

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

I agree with this observation of @spier:

Right now our main README is the starting point of the ISC Patterns for all users (readers and contributors). You could say the main README is the homepage for ISC Patterns :)

Assuming that the majority of the users will be just readers, I would like to make the main README as simple and short for the readers as possible.

This will likely change once we have releases of a patterns catalogue or e-book as PDF, interactive website, etc. But in the current state, I think, the changes proposed with this PR will improve the experience for readers.

@spier
Copy link
Member Author

spier commented Apr 28, 2020

Great. @lenucksi, ready to merge? :)

Copy link
Member

@lenucksi lenucksi left a comment

Choose a reason for hiding this comment

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

Great. @lenucksi, ready to merge? :)

Yes. Big green button time!.

However the link check is not running automatically. It might only be triggered by a push to master right now actually? Not sure, as I don't know GitHub Actions in that much detail.

This is more or less as expected. And yes, your assumption is correct. We likely need to adapt the actions description to trigger on PR
Do you want to file a quick PR for this?
Side note: We can have as much GitHub Actions actions as we want, i.e. could split scripts to run on pushes to master from those running on PR.

I also agree with the sentiment on separation for Contributors and Users brought forward by @spier . I also agree with @NewMexicoKid.
And most cases I've answered "to split or not to split" based on the extent of the contributor focused material. We have quite a bit in that regard. Hence I'd go for splitting for now. And change things again when they need changing. :)

On a different note (and l'd be very happy to deal with that in another PR, just wanted to mention it here too so that the context is created): Do we need and if so how do we integrate the works in #155 in these changes?

@lenucksi lenucksi merged commit 1c0d78a into InnerSourceCommons:master Apr 29, 2020
@spier spier deleted the move-meta-info branch April 29, 2020 19:06
@spier spier mentioned this pull request Apr 29, 2020
@maxcapraro
Copy link
Member

On a different note (and l'd be very happy to deal with that in another PR, just wanted to mention it here too so that the context is created): Do we need and if so how do we integrate the works in #155 in these changes?

I don't think there is much conflict. #153 makes sense - Thanks for contributing and merging this :)

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