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

Add Software Architecture #1503

Merged
merged 8 commits into from
May 9, 2019
Merged

Add Software Architecture #1503

merged 8 commits into from
May 9, 2019

Conversation

simskij
Copy link
Contributor

@simskij simskij commented Jan 16, 2019

https://github.com/simskij/awesome-software-architecture

this list is about systems architecture and includes articles, resources, books, tools etc. on that topic. from what i could tell, no other list curates resources in this layer and as the "art" of working with systems architecture in many senses differ from doing actual programming a separate list for this feels appropriate.

PR Reviews
PR 1501
PR 1497

@sindresorhus
Copy link
Owner

Thanks for making an Awesome list! 🙌

It looks like you didn't read the guidelines closely enough. I noticed multiple things that are not followed. Try going through the list point for point to ensure you follow it. I spent a lot of time creating the guidelines so I wouldn't have to comment on common mistakes, and rather spend my time improving Awesome.

@sindresorhus
Copy link
Owner

❯ awesome-lint https://github.com/simskij/awesome-architecture
✖ Linting

  readme.md:35:3
  ✖   1:1   Missing or invalid Table of Contents         awesome/toc
  ✖   1:1   Git repository must be at least 30 days old  awesome/git-repo-age
  ✖   1:25  Invalid badge source                         awesome/badge
  ✖   7:3   Invalid list item link URL                   awesome/list-item
  ✖   8:3   Invalid list item link URL                   awesome/list-item
  ✖   9:3   Invalid list item link URL                   awesome/list-item
  ✖  10:3   Invalid list item link URL                   awesome/list-item
  ✖  11:3   Invalid list item link URL                   awesome/list-item
  ✖  35:3   Link to http://www.gentleware.com/ is dead   no-dead-urls
  ✖  39:2   License image must be SVG                    awesome/license

https://github.com/sindresorhus/awesome-lint

@simskij
Copy link
Contributor Author

simskij commented Jan 25, 2019

Thanks for your feedback, @sindresorhus.
All linting steps now pass.

awesome-architecture $ yarn test                                         master
yarn run v1.12.3
$ awesome-lint
✔ Linting
✨  Done in 3.20s.

@simskij
Copy link
Contributor Author

simskij commented Feb 6, 2019

Ping @sindresorhus 😄

@sindresorhus
Copy link
Owner

The list is a little bit light on content. Put more more work into it.

readme.md Outdated
@@ -605,7 +605,7 @@
- [Speakers](https://github.com/karlhorky/awesome-speakers#readme) - Conference and meetup speakers in the programming and design community.
- [Software Patreons](https://github.com/uraimo/awesome-software-patreons#readme) - Fund individual programmers or the development of open source projects.
- [Parasite](https://github.com/ecohealthalliance/awesome-parasite#readme) - Parasites and host-pathogen interactions.

- [Systems Architecture](https://github.com/simskij/awesome-architecture#readme) - Create, evaluate and reason about systems architecture.
Copy link
Owner

Choose a reason for hiding this comment

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

The entry in the Awesome list should:
Include a short description about the project/theme of the list. It should not describe the list itself.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks! Changed.

Choose a reason for hiding this comment

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

Thanks !!!

@sindresorhus sindresorhus changed the title Add systems architecture Add Systems Architecture Feb 22, 2019
@sindresorhus
Copy link
Owner

The readme heading should be Awesome Systems Architecture, not awesome-architecture.

@sindresorhus
Copy link
Owner

I think you should rename the repo too. Just awesome-architecture is too generic and makes people think it's about building architecture.

@simskij
Copy link
Contributor Author

simskij commented Mar 30, 2019

The list is a little bit light on content. Put more more work into it.

Thanks for the feedback. I'm trying to value high-quality content over quantity. Hopefully, some exposure from the awesome list of awesome lists would help in providing good content in a more rapid pace. Until then, I'm updating it every once in a while when I have something valuable to add. 👍

I think you should rename the repo too. Just awesome-architecture is too generic and makes people think it's about building architecture.

On a social coding platform like github, one would think the opposite would be the case right? Having to specify "awesome-building-architecture" if it's not systems architecture. 😜

@NewAlexandria
Copy link

Having to specify "awesome-building-architecture" if it's not systems architecture.

There are many kinds of architecture, even within software engineering. I agree that it would be confusing if left named as such. I side with the idea that this is an important change.

Also, IMO, looking at the list, it leaves out many important things about software architecture. If the merge were my call, I would want to see this awesome-list developed further before merge. Paper We Love is a great resource for important topics in software architecture.

@simskij simskij changed the title Add Systems Architecture Add Software Architecture Mar 31, 2019
@simskij
Copy link
Contributor Author

simskij commented Mar 31, 2019

There are many kinds of architecture, even within software engineering. I agree that it would be confusing if left named as such. I side with the idea that this is an important change.

In that case I'd rather opt for the wider definition.

The repo has now been renamed to awesome-software-architecture, and the link in the readme has been updated to reflect that change.

@simskij
Copy link
Contributor Author

simskij commented Apr 30, 2019

@sindresorhus time for another evaluation? the list has more than twice the content compared to 22 february.

@sindresorhus
Copy link
Owner

Devops => DevOps

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@sindresorhus
Copy link
Owner

Includes a succinct description of the project/theme at the top of the readme. (Example)

@simskij
Copy link
Contributor Author

simskij commented May 9, 2019

Includes a succinct description of the project/theme at the top of the readme. (Example)

thanks, fixed. 🙌

@sindresorhus sindresorhus merged commit ea499bf into sindresorhus:master May 9, 2019
@sindresorhus
Copy link
Owner

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants