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

Redo README and add current status note #3750

Merged
merged 3 commits into from May 5, 2017
Merged

Redo README and add current status note #3750

merged 3 commits into from May 5, 2017

Conversation

willkg
Copy link
Collaborator

@willkg willkg commented May 3, 2017

We no longer support Socorro and we're making big changes. Seems prudent to let
users know the status and what the last good commit was.

We no longer support Socorro and we're making big changes. Seems prudent to let
users know the status and what the last good commit was.
@peterbe peterbe requested a review from lonnen May 3, 2017 18:41
@willkg
Copy link
Collaborator Author

willkg commented May 3, 2017

@lonnen Is the text here clear enough? My concern is that I'm going to go delete all the collector code and given that users continue to use Socorro and ask for support, I don't think we've been super clear about how we're not supporting Socorro anymore and how we're making backwards-incompatible changes.

So this text makes that clearer and gives them a sha for the last good commit (for some definition of "last good commit").

README.rst Outdated
This is a very Mozilla-specific product. We do not currently have the capacity
to support external users. If you are looking to use Socorro for your product,
maybe you want to consider alternatives like `electron/mini-breakpad-server
<https://github.com/electron/mini-breakpad-server>`_.
Copy link
Contributor

Choose a reason for hiding this comment

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

let's list https://github.com/wk8/sentry_breakpad as an alternative also

README.rst Outdated
Socorro
=======

Socorro is a set of services for collecting, processing, and displaying crash
Copy link
Contributor

Choose a reason for hiding this comment

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

consider adding a word or two to emphasize Mozilla-specific

README.rst Outdated

Current deployment status: https://whatsdeployed.io/s-7M7

Infrastructure (AWS) code: https://github.com/mozilla/socorro-infra
Copy link
Contributor

Choose a reason for hiding this comment

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

should we note that this repo is similarly deprecated?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have no idea if it is or not. I thought it was Mozilla-centric and there was no expectation that it was supported in any way.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'll add a note about how this is Mozilla-centric and not supported, too.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@lonnen
Copy link
Contributor

lonnen commented May 5, 2017

Rather than do a date-base series of updates as we pull components, consider anointing a tag as the last holistic release of the system.

@willkg
Copy link
Collaborator Author

willkg commented May 5, 2017

I'll switch it to a tag--that's a good idea.

I was thinking "this is the last known good one" after which we have carte blanche to make any changes we want. I wasn't planning on doing further status updates.

@willkg
Copy link
Collaborator Author

willkg commented May 5, 2017

@lonnen ^^^ Does that look good?

@willkg
Copy link
Collaborator Author

willkg commented May 5, 2017

I think I addressed all of @lonnen's comments and that this is fine. If not, we can do another PR.

@willkg willkg merged commit 3659785 into mozilla-services:master May 5, 2017
@lonnen
Copy link
Contributor

lonnen commented May 7, 2017 via email

@willkg willkg deleted the changes-note branch May 8, 2017 23:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants