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

README/ISSUE_TEMPLATE: point to docs and discourse #454

Merged
merged 6 commits into from Mar 27, 2020

Conversation

hsanjuan
Copy link
Contributor

We need to make the documentation site the place to find all the information that is currently here.
This is not a place to open issues, plus this is badly maintained and rarely updated.

Until docs-beta lands, at least mention it in some links.

@jessicaschilling what are the plans for this repo? Ideally all the info in the readme should be ingested to the docs or dropped/replaced-by-a-link because there are better places where that information is maintained.

We need to make the documentation site the place to find all the information
here. This is not a place to open issues, plus this is badly maintained and
rarely updated.

Until docs-beta lands, at least mention it in some links.
@hsanjuan hsanjuan self-assigned this Mar 21, 2020
@jessicaschilling
Copy link
Contributor

jessicaschilling commented Mar 21, 2020

@hsanjuan --

  • All proposed repo fixes from the ecosystem audit can be found here, including links to longer descriptions of each.
  • For convenience, direct link to item for the "do something about ipfs/ipfs" recommendation.

The short answer is that yes -- ideally this repo should (probably) still exist, but have issue-opening disabled, and the readme should really just be an evergreen set of links to the things that are being regularly updated. However, someone will need to own this -- @autonome noted his support to prioritize repo fixes overall in Q2 for the developer experience group, but we need to get those efforts into someone's actual Q2 plans who isn't already full up with work.

Regarding linking to docs beta rather than legacy docs: feel free to direct-link to docs beta. The legacy docs deprecation plan includes a step for searching all our repos for mention of such links, and amending them.

Copy link
Contributor

@jessicaschilling jessicaschilling left a comment

Choose a reason for hiding this comment

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

Thank you for triaging this! And appreciate your thoughts on longer-term plans. Let's try to get this on someone's Q2 agenda as part of some larger repo-cleanup work.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
hsanjuan and others added 5 commits March 22, 2020 11:58
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
Co-Authored-By: Jessica Schilling <jessica@protocol.ai>
@jessicaschilling jessicaschilling merged commit 003bfb1 into master Mar 27, 2020
@jessicaschilling jessicaschilling deleted the point-to-docs-and-discourse branch March 27, 2020 17:57
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.

None yet

2 participants