hoaproject / W3

The W3 repository contains the website of Hoa.
4 stars 8 forks source link

adding some related project links #46

Open Grummfy opened 9 years ago

Grummfy commented 9 years ago

In the documentation It would be really cool and useful to have like for blog "related blog post links" a related project links that make some links to project using this or this part of hoa. This will allow people see real example and make them comfortable with the use of a lib.

thanks

Hywan commented 9 years ago

I am totally with that! What do you think guys (/cc @hoaproject/hoackers). Maybe we should ping @K-Phoen with rulez, @shouze and @stephpy with their math library, @Halleck45 with PHPMetrics, @th3fallen with ownCloud (but the code is not open-source, am I right?), @agallou with atoum/ruler-extension, @marmotz with the Websocket Symfony bundle etc etc.

I don't know yet how to design it. Maybe, at the end of the documentation, after the “Conclusion” Section and before the “Comment” Section, we could add something like this:

Related projects

The following projects use this library:

  • [name of the project](link to the project): description.

No logo. No intrusive ads. Something very similar to the “Awecodes” Section in README.md files (example: https://github.com/hoaproject/Websocket#awecode).

Thoughts?

Hywan commented 9 years ago

And if there is no “known project” using a library, we should add a link:

Want your project here? Contact us”

But who decides which projects to select?

Grummfy commented 9 years ago

For me, I was also thinking to add in the documentation itself some link to project for specific parts. Example, for hoa/ruler if someone had many rules (even simple one), it could be interesting to link this in the documentation)

th3fallen commented 9 years ago

@Hywan sadly the firewall aspect is not open sourced it is a part of our enterprise offering.

Hywan commented 9 years ago

@Grummfy: Yup, we are talking about the hack book.

Hywan commented 7 years ago

@Grummfy Since it is done in the README.md, should we still add it to the documentation?

Hywan commented 7 years ago

hoaproject/Central#19