Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit e9b1691

Browse files
authored
alice: CONTRIBUTING: Tutorials: Add link to Coach Alice Our Open Source Guide tutorial
For help extending `alice please contribute recommended community standards`
1 parent d4153ef commit e9b1691

File tree

1 file changed

+30
-6
lines changed

1 file changed

+30
-6
lines changed

entities/alice/CONTRIBUTING.rst

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ Using a cloud development environment gives you a place to work
3131
that already has everything installed and configured. You can
3232
start playing around and writing code immediatly.
3333

34+
**NOTE** Not sure what state gitpod is in, pretty sure there
35+
was some sort of issue we need to move a file around or something.
36+
3437
https://gitpod.io/#github.com/intel/dffml/tree/alice
3538

3639
Cloning the Repo
@@ -124,18 +127,39 @@ intended to do development work on the as well.
124127
-e ../../operations/innersource/ \
125128
-e ../../configloader/yaml/
126129
130+
Tutorials
131+
*********
132+
133+
These are tutorials on how to extend parts of Alice, they are backlinked from
134+
her README.
135+
136+
- https://github.com/intel/dffml/blob/alice/docs/tutorials/rolling_alice/0001_coach_alice/0002_our_open_source_guide.md
137+
127138
Data Flow Programming
128139
*********************
129140

130141
Data Flow programming focueses on data types and data transformations.
131142
Data Orented Design is also helpful in understanding Data Flow programming,
132143
altough a distinct concept itself.
133144

134-
- https://youtu.be/D9puJiKKKS8?t=873
135-
- https://github.com/intel/dffml/blob/alice/docs/concepts/dataflow.rst
136-
- https://en.wikipedia.org/wiki/Dataflow_programming
137-
- https://www.gamedeveloper.com/programming/tips-on-writing-code-for-data-oriented-design
138-
- https://www.youtube.com/watch?v=aPh4Z3SioB8
145+
- Tutorials on DFFML Operations / DataFlows
146+
147+
- https://intel.github.io/dffml/main/examples/shouldi.html
148+
- https://intel.github.io/dffml/main/examples/dataflows.html
149+
150+
- Talk snippit explaining above tutorial
151+
152+
- https://youtu.be/D9puJiKKKS8?t=873
153+
154+
- Concuptual docs on data flow execution
155+
156+
- https://intel.github.io/dffml/main/concepts/dataflow.html
157+
158+
- Misc. References
159+
160+
- https://en.wikipedia.org/wiki/Dataflow_programming
161+
- https://www.gamedeveloper.com/programming/tips-on-writing-code-for-data-oriented-design
162+
- https://www.youtube.com/watch?v=aPh4Z3SioB8
139163

140164
Finding Data Types to Work With
141165
*******************************
@@ -155,7 +179,7 @@ data types available within the flow.
155179
.. code-block:: console
156180
157181
$ dffml service dev export alice.cli:AlicePleaseContributeCLIDataFlow | tee alice.please.contribute.recommended_community_standards.json
158-
$ dffml dataflow diagram alice.please.contribute.recommended_community_standards.json
182+
$ dffml dataflow diagram -shortname alice.please.contribute.recommended_community_standards.json
159183
160184
.. image:: https://user-images.githubusercontent.com/5950433/176561571-cb866c83-4b4c-48f0-9dee-91c9ae7a12f5.svg
161185

0 commit comments

Comments
 (0)