Skip to content
This repository has been archived by the owner on Sep 20, 2021. It is now read-only.

Add an article about recent libraries deprecation. #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

shulard
Copy link
Contributor

@shulard shulard commented Jun 14, 2018

We choose to drop unused, unpopular and not relevant part of Hoa and it's important to write about that.

Related to : hoaproject/Central#90

It's a quick and simple article, maybe we need to add more details ?

Copy link
Member

@Hywan Hywan left a comment

Choose a reason for hiding this comment

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

Despites some modifications, the post looks good to me. It is clear, and we understand the motivations. Thanks your very much!

<p>Hoa is a set of 61 PHP libraries, during our <a href="http://discourse.hoa-project.net/t/hoa-virtual-meeting/22/34">latest
Virtual Meeting</a> we choose to deprecate some libraries. This is important
for us to ensure that Hoa stays relevant and up to date regarding real
world needs.<br/>
Copy link
Member

Choose a reason for hiding this comment

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

You can remove the <br />.

Virtual Meeting</a> we choose to deprecate some libraries. This is important
for us to ensure that Hoa stays relevant and up to date regarding real
world needs.<br/>
We choose to remove the ones that are:</p>
Copy link
Member

Choose a reason for hiding this comment

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

- We choose to
+ We have decided to

world needs.<br/>
We choose to remove the ones that are:</p>
<ol>
<li>Un-used or unpopular,</li>
Copy link
Member

Choose a reason for hiding this comment

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

“Unpopular” in this context means libraries that people don't like. This is wrong in some regards.

I would rephrase like this:

Basically un-used (with less than 100 downloads in 5 years).

<li>Not relevant anymore because they refer to dead technologies.</li>
</ol>
<p>The main goal is to reduce the effort to maintain the Hoa ecosystem.</p>
<p>To be sure about the list, we checked some packagist and github stats.
Copy link
Member

Choose a reason for hiding this comment

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

- the list
+ the list items

Copy link
Member

Choose a reason for hiding this comment

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

- some packagist and github stats
+ Packagist and GitHub statistics

</ol>
<p>The main goal is to reduce the effort to maintain the Hoa ecosystem.</p>
<p>To be sure about the list, we checked some packagist and github stats.
We also choose to keep the one used internally at the moment.</p>
Copy link
Member

Choose a reason for hiding this comment

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

- the one used internally
+ the ones we use for private projects

<p>The main goal is to reduce the effort to maintain the Hoa ecosystem.</p>
<p>To be sure about the list, we checked some packagist and github stats.
We also choose to keep the one used internally at the moment.</p>
<p>Some of the libraries weren't registered on packagist which means that
Copy link
Member

Choose a reason for hiding this comment

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

- packagist
+ Packagist

<p>The deprecation process is simple:</p>
<ol>
<li>Abandon the project on Packagist,</li>
<li>Update the README.md file to inform users,</li>
Copy link
Member

Choose a reason for hiding this comment

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

- README.md
+ <code>README.md</code>

<ol>
<li>Abandon the project on Packagist,</li>
<li>Update the README.md file to inform users,</li>
<li>Archive the repository on Github.</li>
Copy link
Member

Choose a reason for hiding this comment

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

You can add that mirrors are also updated to reflect this change.

</ol>
<p>Here is the whole list of deprecated libraries:</p>
<ul>
<li><a href="https://github.com/hoaproject/cache">hoa/cache</a></li>
Copy link
Member

Choose a reason for hiding this comment

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

- hoa/cache</a>
+ <code>hoa/cache</code></a>,

etc.

We choose to drop unused, unpopular and not relevant part of Hoa and it's important to write about that.
Related to : hoaproject/Central#90
@shulard
Copy link
Contributor Author

shulard commented Aug 16, 2018

Hello @Hywan, I've updated the article with all your feedbacks 😄.

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

Successfully merging this pull request may close these issues.

2 participants