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 'Education' section #656

Merged
merged 7 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 253 additions & 0 deletions docs/about-cardano/06-contributions.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
---
title: Contribution guidelines
metaTitle: Contribution guidelines
metaDescription: Contribution guidelines
sidebar_position: 6
---

import ReactPlayer from 'react-player'

The Cardano Docs site follows the principles of open-source collaboration,
inclusiveness, and community-driven success. Contributing to Cardano Docs helps
create a rich, accurate, and up-to-date resource for the entire Cardano
community. By sharing your knowledge and expertise, you ensure the documentation
remains a valuable and reliable source of information for all.

Note that Cardano Docs focuses on providing information about Cardano's
functionalities and features, while the
[Developer Portal](https://developers.cardano.org/) offers developer-related
tutorials and guides. These two resources exist in tandem, ensuring a seamless
user experience for both general users and developers.

By using this website and contributing to Cardano Docs, you agree to be bound by
and comply with the CC BY 4.0 license.

## What to contribute?

You can contribute in several ways, including:

- **Edits**: spot typos or inaccuracies? Fix them!
- **Feature overviews**: suggest additional overviews or functionality
explainers relevant to Cardano
- **References**: add more references to community-driven projects or resources
- **Graphics**: contribute with graphics, infographics, etc. Please refer to the
[Cardano branding assets](https://cardano.org/brand-assets/) for this.

## How to contribute?

### Creating a pull request

1. **Find the page**: navigate to the page you want to edit
2. **Edit the page**: click the ‘Edit this page’ button
3. **Make changes**: make changes using
[Markdown (MD) formatting](https://docusaurus.io/docs/next/markdown-features)
and adhere to the style guidelines (please see below)
4. **Create a pull request**: submit your changes through a pull request.

<div style={{ width: '100%', maxWidth: '700px', paddingBottom: '1.5rem' }}>
<ReactPlayer width={'100%'} controls url="/pull-request-render.mp4" />
</div>

If you prefer working with GitHub locally, follow these steps:

1. **Fork the repository**: go to the
[Cardano Docs GitHub repository](https://github.com/input-output-hk/cardano-documentation)
and fork it to your account
2. **Clone the repository**: clone the forked repository to your local machine
3. **Create a new branch**: create a new branch for your changes
4. **Make your edits**: edit the documentation files using MD formatting
5. **Commit your changes**: commit your changes with a clear and descriptive
message
6. **Push to GitHub**: push your changes to your forked repository
7. **Submit a pull request**: open a pull request from your new branch to the
main repository.

See more about
[Docusaurus set up here](https://github.com/input-output-hk/cardano-documentation?tab=readme-ov-file#website).

### Raising an issue

By raising an issue, you can identify areas for improvement, report problems, or
suggest new content.

To create an issue:

1. **Go to the GitHub repository**: navigate to the Cardano Docs
[GitHub repository](https://github.com/input-output-hk/cardano-documentation)
2. **Create a new issue**: click ‘Issues’ and then ‘New issue’
3. **Describe the issue**: provide a clear and detailed description of the issue
or suggestion
4. **Submit the issue**: click ‘Submit new issue.’

Your contributions are vital to maintaining the quality and integrity of Cardano
Docs. Whether you’re correcting a typo, adding new content, or suggesting
improvements, every contribution helps. Thank you for being an active Cardano
community member and helping make Cardano Docs an invaluable resource for
everyone.

## Style guide

### General notes

Ensure simplicity, accuracy, and accessibility. Aim for a broad understanding,
even for select audiences. Be concise – avoid unnecessary words.

### Style principles

**Language**

- Use American English: -ize rather than -ise endings, ‘color’ instead of
‘colour’
- Avoid slang words
- Use gender-inclusive pronouns – they/their/them
- Active voice, avoid passive.

**Abbreviations and acronyms**

- No full stops in abbreviations: eg, ie, PhD, etc, v (note, not vs), plc, Inc
- Write acronyms as said (eg, radar, laser, captcha), use initial caps for
entities, avoid capitalization
- Minimize the use of acronyms and initialisms. Spell out on first use, eg
peer-to-peer (P2P)
- Refer to the [Cambridge dictionary](https://dictionary.cambridge.org/).

**Legal and investment**

- Avoid investment or legal advice.

**Punctuation**

- Use the Oxford/serial comma
- Use single quote marks: ‘cascading disruption’
- Use en dash – (option-hyphen on a Mac keyboard; Alt-hyphen on PC)
- Use a full stop at the end of the last bullet point.

**Capitalization**

- Lowercase for job titles, degree names, and university departments
- Use lowercase after a colon, eg ‘Feature: this feature is about…’
- Book, film, and game titles should be in italics, and academic papers should
be in ‘single quotes’ – avoid subtitles.

**Numbers and time**

- Spell out one to nine: one, two, three, four, five, once I caught a fish
alive, except for percentages: 1%, 2%, 3%
- Use numerals for anything higher: 10, 11, 12, 13, 14, 15
- Spell out million, billion when in prose: there are nine million bicycles in
Beijing
- Use abbreviations for money: £5m, $10bn, 12tn yen
- When talking generally, use MMMM DD, YYYY format, eg February 1, 2018
- For technical purposes, use ISO 8601 standard for dates and time: YYYY-MM-DD
eg 2018-02-01.

**Bullet lists**

- Start with a capital letter and use full stops in complete sentences. You can
format the bullet ‘title’ in bold if there is one:
- Feature name 1. This full sentence describes the feature in more detail.
- Feature name 2. This full sentence describes the second feature in more
detail.
- Omit full stops in short itemized lists; use it after the last bullet point.
For example, the discussed feature includes such items as:
- Item 1
- Item 2
- Item 3.
- In shorter statements, full stops can also be omitted. For example:
- Maintain uniformity across all documentation
- Encourage user interaction with clear instructions
- Incorporate visuals judiciously to enhance understanding.

**Links**

- Write clear and meaningful links; don’t use ‘here’ as a link. Always embed
links; don’t just paste one as is.

**Headlines and titles**

- Headlines are ‘Sentence case only’. The limited use of capitals is a way of
avoiding confusion for proper names. Use initial caps for navigation section
names and topic headings.
- No full stops at the end of headlines, pull quotes, captions, and other
display matter, or when referencing figures: just ‘See Figure 1 for details…’.

### Markdown features

Cardano Docs uses Markdown for formatting. Below are the main Markdown features:

**Headers**

- Use `#` for H1, `##` for H2, and so on.

```markdown
# H1

## H2

### H3
```

**Emphasis**

- Use `*` or `_` for italics, `**` or `__` for bold.

```markdown
_italic_ or _italic_

**bold** or **bold**
```

**Lists**

- Use `-` or `*` for unordered lists and `1.` for ordered lists.

```markdown
- Item 1

- Item 2

* Item 3.

1. First item

2. Second item.
```

**Links**

- Use `[text](url)` for links.

```markdown
[Cardano Docs](https://docs.cardano.org/)
```

**Images**

- Use `![alt text](url)` for images.

**Code**

- Use backticks for inline code and triple backticks for code blocks.

**Blockquotes**

- Use `>` for blockquotes.

```markdown
> This is a blockquote.
```

**Tables**

- Use `|` to create tables.

```markdown
| Header 1 | Header 2 |

|----------|----------|

| Cell 1 | Cell 2 |
```

For more details, see
[MD features here](https://docusaurus.io/docs/next/markdown-features).
70 changes: 70 additions & 0 deletions docs/pioneer-programs/00-education.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Input | Output education
metaTitle: Education overview
sidebar_position: 1
---

## IO initiatives

Education is a cornerstone of fostering a knowledgeable and engaged global community. By prioritizing education, IO aims to share its expertise and empower individuals to contribute meaningfully to the Cardano ecosystem. Whether you're a developer, an academic, or a business professional, IO educational offerings are designed to equip you with the skills and knowledge needed to thrive in the blockchain space.

The team brings together extensive experience in curriculum design, project management, and the technical intricacies of Cardano, Haskell, and smart contracts. This collective skill set ensures that educational programs are comprehensive, practical, and tailored to diverse learners' needs.

## Partnerships

The IO education team has partnerships with various universities and educational institutions worldwide to deliver high-quality education, including:

- [University of Edinburgh](https://www.ed.ac.uk/), where there is a blockchain laboratory run by IO’s chief scientist, [Prof Aggelos Kiayias](https://iohk.io/en/leadership/aggelos-kiayias), and his research team
- [University of Athens](https://en.uoa.gr/)
- [University of West Indies](https://www.uwi.edu/)
- [University of Wyoming](https://www.uwyo.edu/index.html)
- [Carnegie Mellon University](https://www.cmu.edu/)
- [European Business University of Luxembourg](https://ebulux.lu/)
- [University of Malta](https://www.um.edu.mt/).

Additionally, the team has worked on curriculum design for blockchain programs with Yeovil College in the UK and Consilium Academy in South Africa.

## Course offerings

### Mission-based education

- **Cardano Days**: interactive events providing a deep dive into the Cardano platform, covering its unique features and applications.
- **Mastering Cardano**: comprehensive book designed to provide an in-depth understanding of the Cardano blockchain. This work is in progress, so stay tuned for updates.

The education team has held several Cardano Day events across different locations:

- [ITESO University](https://www.iteso.mx/en/), Guadalajara, Mexico
- [University of Celaya,](https://www.udec.edu.mx/en/) Guanajuato, Mexico
- [University of Malta](https://www.um.edu.mt/), Valletta Campus, Valletta, Malta
- [University of Wyoming](https://www.uwyo.edu/index.html), Laramie, USA.

These events cover the basics of blockchain technology, Cardano, and smart contracts and prove very popular, with a typical NPS score of 92.

More events are continually planned, and if you would like to know more about hosting a Cardano Days event, please [get in touch](mailto:education@iohk.io).

### Developer education

- [Cardano Developer course](https://github.com/iog-edu-argentina-2024/cardano-dev-2024): a program to train developers in building smart contracts and decentralized applications (DApps) on the Cardano platform.
- [Plutus Pioneer program](https://docs.cardano.org/pioneer-programs/plutus-pioneers/): focuses on Plutus, Cardano’s smart contract platform, offering hands-on experience in writing and deploying smart contracts.
- [DRep Pioneer program](https://sancho.network/drep-pioneer-program/drep-pp/overview): prepares participants to become delegate representatives, playing a crucial role in Cardano’s governance.
- [Haskell Bootcamp](https://github.com/input-output-hk/haskell-course?tab=readme-ov-file#haskell-course): an immersive self-paced Haskell course. This course provides a stepping stone for people to upskill on Haskell before enrolling in the Plutus Pioneer program. It consists of videos and interactive lessons and has received positive feedback and engagement.
- **Hackathons**: support for hackathons in universities and at various blockchain events. Previous hackathons have been held in Mongolia, the USA, and Argentina.


### Internal training

- **Plutus internal training**: based on the Plutus Pioneer program, this course offers insights into the core smart contract functionality.
- **IO Maths Academy**: basic category theory course, which teaches how to build stronger code with mathematical precision to gain knowledge about the functional approach to mathematics. The advanced course is planned for release in 2025.

### Academic and business collaborations

IO also engages in academic and business collaborations, offering specialized lectures and workshops on blockchain and Cardano. These programs bridge the gap between theoretical knowledge and practical application, fostering innovation and real-world problem-solving skills.

Some example initiatives include:

- Smart contract lectures (virtual and in-person) at the [University of Malta](https://www.um.edu.mt/)
- Cardano Developer course with the [National Technological University](https://utn.edu.ar/es/) in Buenos Aires.

### Resources

For more updates, please subscribe to the [IO Academy YouTube channel,](https://www.youtube.com/channel/UCX9j__vYOJu00iqBrCzecVw) where the team regularly publishes new lectures and educational content.
25 changes: 11 additions & 14 deletions docs/pioneer-programs/01-plutus-pioneers.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
---
title: Plutus Pioneer program
metaTitle: Plutus Pioneer program
sidebar_position: 1
sidebar_position: 2
---

> Before you start, note that Plutus Core, Cardano’s native smart contract
> language, is written in Haskell. Plutus contracts are effectively Haskell
> programs and that is why it is essential to know the basics of Haskell before
> enrolling in the Plutus Pioneer program.
:::info

> In preparation, we recommend that you complete our new self-paced
> [Haskell Bootcamp](https://github.com/input-output-hk/haskell-course?tab=readme-ov-file#haskell-course) course. This
> stepping stone course offers unique code examples and interesting exercises
> that have prepared solutions to help you can learn the fundamentals of
> Haskell.
Before starting, note that Plutus Core, Cardano’s native smart contract language, is written in Haskell. Since Plutus contracts are Haskell programs, a basic understanding of Haskell is essential for the Plutus Pioneer program.

Therefore, it is recommended that users complete this self-paced [Haskell Bootcamp](https://github.com/input-output-hk/haskell-course?tab=readme-ov-file#haskell-course) course, which includes unique code examples, engaging exercises, and prepared solutions to learn Haskell fundamentals.

:::

## What is the Plutus Pioneer program?

Expand All @@ -32,13 +29,13 @@ in formal methods, programming experience and a general aptitude for logical and
mathematical thinking are highly desirable. Some prior knowledge of Haskell or
functional programming is also recommended, as Plutus is heavily based on
Haskell and includes advanced features like Template Haskell, type-level
programming, and effect systems. We recommend that you work through **IOGs**
programming, and effect systems. We recommend that you work through **IO's**
official [Haskell Course](https://github.com/input-output-hk/haskell-course).
You can also read the [Learn You a Haskell](http://learnyouahaskell.com/) book.

## What can I expect to learn?

This course involves approximately ten hours a week of your time and efforts. It
This course involves approximately ten hours a week of your time and effort. It
covers the building blocks of Haskell and Plutus, including:

- Functions and data types
Expand All @@ -48,9 +45,9 @@ covers the building blocks of Haskell and Plutus, including:
- Extended UTXO model
- Working with Plutus (on and off the chain)
- Minting policies
- Some case studies and practical exercises
- Some case studies and practical exercises.

As with all learning experiences, the more you put in the more you will get out!
As with all learning experiences, the more you put in, the more you will get out!

## When can I join?

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ const config: Config = {
position: 'left',
},
{
to: 'pioneer-programs/plutus-pioneers',
to: '/pioneer-programs/education',
label: 'Education',
position: 'left',
},
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@
"react-tooltip": "^4.2.21",
"styled-components": "^6.1.10",
"styled-icons": "^9.0.1",
"victory": "^36.5.3"
"victory": "^36.5.3",
"react-player": "^2.16.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.1.1",
Expand Down
Binary file added static/pull-request-render.mp4
Binary file not shown.
Loading
Loading