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

Create a samples directory #470

Closed
sharifsalah opened this issue Oct 9, 2019 · 0 comments · Fixed by #471
Closed

Create a samples directory #470

sharifsalah opened this issue Oct 9, 2019 · 0 comments · Fixed by #471
Assignees
Labels
enhancement Improvement to an existing feature

Comments

@sharifsalah
Copy link
Collaborator

Describe the enhancement

Create a top-level samples directory to organize and store sample code that compliments the documentation. Currently, there is some sample code and a tutorial under the /pyoutline directory. I suggest moving this to a new central /samples directory that isolates sample code away from the application source code for the project.

The accompanying tutorial under pyoutline/tutorials/tutorial.html is very out of date and is no longer very relevant to the current version of OpenCue. I've copied the information in this tutorial (along with an archive of the the HTML file) to an issue in the opencue.io repository. Over time we should incorporate the outdated tutorial and current sample code into the documentation.

For now, the new samples/ directory can host more urgent sample code to help illustrate common admin tasks, such as managing RQD nodes.

Screenshots
N/A

Version Number
N/A

Additional context
N/A

@sharifsalah sharifsalah added the enhancement Improvement to an existing feature label Oct 9, 2019
@sharifsalah sharifsalah self-assigned this Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant