pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

Fixing documentation/noting potentially at-risk links

Open preland opened this issue 3 years ago • 3 comments

Description of the Change

Fixing documentationnoting potentially at-risk links

Release Notes

-Added notation for documentation files that appeared to be little more than leftovers from Atom. Some files might be false flagged, and those are marked as such.

-Added comments throughout the codebase whenever a link to the official Atom repo was mentioned, as these links may become obsolete after sunset, and may need to be altered/preserved to maintain an understanding of the original source code, as well as future-proofing the codebase.

-Also did a few minor tweaks to client-side text; most notably changing the crash reporting website listed from github.com/atom/atom to github.com/pulsar-edit/pulsar/issues/new/choose. While I don't personally think these minor changes warrant an extra pull request, these changes could be removed and added to another pull request.

preland avatar Oct 16 '22 04:10 preland

Going through this looks fantastic currently. Although heres a few requests/recommendations.

For things like the PR Template, or Issue Templates, those can be removed entirely since we have those propagating through our .github repo, and once removed the repo will just use whats there, as that is what we are doing on every other repo.

Additionally for the CONTRIBUTING.md file I would recommend changing that to our current recommend format, as detailed in our contributing docs. And lastly for what I've found so far, it may be best to change the CODE_OF_CONDUCT.md file here to be an exact copy of the current code of conduct that contributors have drafted available here.

But thanks for the contribution, this looks great so far!

confused-Techie avatar Oct 28 '22 23:10 confused-Techie

Thank you for the feedback. I have added your recommendations to the PR with the latest commit, as well as fixed some other minor issues with the PR.

preland avatar Nov 01 '22 14:11 preland

Thank you for the feedback. I have added your recommendations to the PR with the latest commit, as well as fixed some other minor issues with the PR.

Thanks for taking another look at this. I'll go ahead and review this as soon as I can

confused-Techie avatar Nov 02 '22 00:11 confused-Techie

@preland Would you mind reviewing the conflicts on this PR?

Spiker985 avatar Dec 19 '22 17:12 Spiker985

I will take another look at this PR, as it seems like a lot has changed in the codebase since its initial commit.

Edit: not entirely codebase; a lot of the documentation has also changed

preland avatar Dec 19 '22 18:12 preland

Is this still needed?

Spiker985 avatar Apr 20 '23 07:04 Spiker985

Is this still needed?

I'm sorry to say to @preland but this may not be needed at this point. Since we never did go the way of including more of the community health files into individual repos, and we actually started moving them mostly out.

Additionally, since then we have had the whole discussion of what not to change, siding with not modifying historical data using terms like "Atom" or "GitHub" as that would make them inaccurate, which is happening a lot in this PR.

Plus, considering the huge amount of conflicts, through no fault of the author, it may be best to recreate this PR again if we deemed necessary. But @preland feel free to reopen this or create a new PR updated from master if you want to get these changes in. Sorry we couldn't get to it originally, but at this point it might just be to out of date.

As always appreciate any contributions @preland

confused-Techie avatar Apr 20 '23 23:04 confused-Techie

No, I completely agree, this PR isn't exactly necessary or relevant (or even mergable) currently. Plus, I'm pretty sure the brunt of the concerns that I had have already been addressed by others since the last commit to this PR.

In the case that I feel there is still more to be done, I may make a new PR with some of these changes.

Either way, thank you for your consideration!

preland avatar Apr 22 '23 02:04 preland