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.

Sign up for GitHub

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

Jump to bottom

Keep README code samples updated #5713

Closed
srnagar opened this issue Oct 7, 2019 · 3 comments
Closed

Keep README code samples updated #5713

srnagar opened this issue Oct 7, 2019 · 3 comments
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system. help wanted This issue is tracking work for which community contributions would be welcomed and appreciated
Milestone
Backlog

Comments

@srnagar
Copy link
Member

srnagar commented Oct 7, 2019

Investigate possible options to keep code samples in README functional. Changes to code may result in code samples in README getting outdated and there's no mechanism today to verify the validity of the samples.

Explore options to inject sample code into README from *Sample.java which can be executable.
@loarabia loarabia added Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system. labels Oct 7, 2019
@triage-new-issues triage-new-issues bot removed the triage label Oct 7, 2019
@loarabia loarabia removed the Client This issue points to a problem in the data-plane of the library. label Oct 7, 2019
@srnagar srnagar added Client This issue points to a problem in the data-plane of the library. and removed EngSys This issue is impacting the engineering system. labels Oct 8, 2019
@joshfree joshfree added the EngSys This issue is impacting the engineering system. label Oct 8, 2019
@joshfree
Copy link
Member

joshfree commented Oct 8, 2019

/cc: @mitchdenny @JimSuplizio

@joshfree joshfree added this to the Backlog milestone Oct 8, 2019
@JimSuplizio
Copy link
Member

/cc @scbedd
@joshfree @srnagar This looks related to #5423 in which we're trying to generate docs on a per-package level with each CI build. This should allow the docs to be versioned along with the code. It isn't just the samples in the README files that benefit from this as many README files have a "include the following Maven dependency" section with explicit versions that can get out of sync in the repo but shouldn't in the docs for a given version.

@joshfree joshfree added the help wanted This issue is tracking work for which community contributions would be welcomed and appreciated label Oct 24, 2019
@srnagar
Copy link
Member Author

srnagar commented Dec 5, 2019

Enabled in #6609 and #6625

@srnagar srnagar closed this as completed Dec 5, 2019
@github-actions github-actions bot locked and limited conversation to collaborators Apr 12, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
Client This issue points to a problem in the data-plane of the library. EngSys This issue is impacting the engineering system. help wanted This issue is tracking work for which community contributions would be welcomed and appreciated
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
4 participants
@loarabia @joshfree @JimSuplizio @srnagar