Skip to content

Commit

Permalink
Initialize Content
Browse files Browse the repository at this point in the history
  • Loading branch information
AlveeM committed Jul 10, 2023
0 parents commit 5c1550d
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .github/workflows/canvas-sync.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Sync with Canvas

on:
push:
branches: [master, main]
paths:
- "README.md"

jobs:
sync:
name: Sync with Canvas

runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
ruby-version: 2.6

- name: Install github-to-canvas
run: gem install github-to-canvas

# Secret stored in learn-co-curriculum Settings/Secrets
- name: Sync from .canvas file
run: github-to-canvas -a -lr
env:
CANVAS_API_KEY: ${{ secrets.CANVAS_API_KEY }}
CANVAS_API_PATH: ${{ secrets.CANVAS_API_PATH }}
39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing to Learn.co Curriculum

We're really excited that you're about to contribute to the
[open curriculum](https://learn.co/content-license) on
[Learn.co](https://learn.co). If this is your first time contributing, please
continue reading to learn how to make the most meaningful and useful impact
possible.

## Raising an Issue to Encourage a Contribution

If you notice a problem with the curriculum that you believe needs improvement
but you're unable to make the change yourself, you should raise a Github issue
containing a clear description of the problem. Include relevant snippets of the
content and/or screenshots if applicable. Curriculum owners regularly review
issue lists and your issue will be prioritized and addressed as appropriate.

## Submitting a Pull Request to Suggest an Improvement

If you see an opportunity for improvement and can make the change yourself go
ahead and use a typical git workflow to make it happen:

- Fork this curriculum repository
- Make the change on your fork, with descriptive commits in the standard format
- Open a Pull Request against this repo

A curriculum owner will review your change and approve or comment on it in due
course.

## Why Contribute?

Curriculum on Learn is publicly and freely available under Learn's
[Educational Content License](https://learn.co/content-license). By embracing an
open-source contribution model, our goal is for the curriculum on Learn to
become, in time, the best educational content the world has ever seen.

We need help from the community of Learners to maintain and improve the
educational content. Everything from fixing typos, to correcting out-dated
information, to improving exposition, to adding better examples, to fixing
tests—all contributions to making the curriculum more effective are welcome.
23 changes: 23 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Learn.co Educational Content License

Copyright (c) 2022 Flatiron School, Inc

The Flatiron School, Inc. owns this Educational Content. However, the Flatiron
School supports the development and availability of educational materials in the
public domain. Therefore, the Flatiron School grants Users of the Flatiron
Educational Content set forth in this repository certain rights to reuse, build
upon and share such Educational Content subject to the terms of the Educational
Content License set forth [here](http://learn.co/content-license)
(http://learn.co/content-license). You must read carefully the terms and
conditions contained in the Educational Content License as such terms govern
access to and use of the Educational Content.

Flatiron School is willing to allow you access to and use of the Educational
Content only on the condition that you accept all of the terms and conditions
contained in the Educational Content License set forth
[here](http://learn.co/content-license) (http://learn.co/content-license). By
accessing and/or using the Educational Content, you are agreeing to all of the
terms and conditions contained in the Educational Content License. If you do not
agree to any or all of the terms of the Educational Content License, you are
prohibited from accessing, reviewing or using in any way the Educational
Content.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# OpenAI API Overview and Setup

## Learning Goals

- Learning Goal 1
- Learning Goal 2

## Introduction

A 1-2 sentence summary of what will be covered.

## Topic 1

Discuss the topic of the reading. Break into sections and sub-sections as
appropriate to help with the reader's orientation with the material and future
referencing.

## Topic 2

Discuss the topic of the reading. Break into sections and sub-sections as
appropriate to help with the reader's orientation with the material and future
referencing.

## Conclusion

A short one or two paragraph summary of the contents of the lessons, recapping
the learning goals.

## Resources

- [Resource Link 1](example.com)
- [Resource Link 2](example.com)

0 comments on commit 5c1550d

Please sign in to comment.