Skip to content

Commit

Permalink
Merge branch 'master' into Issue-1093
Browse files Browse the repository at this point in the history
  • Loading branch information
AayushSaini101 authored Mar 28, 2024
2 parents 2aa27ae + e573c88 commit fd0a604
Show file tree
Hide file tree
Showing 9 changed files with 128 additions and 4 deletions.
11 changes: 11 additions & 0 deletions .all-contributorsrc
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,17 @@
"contributions": [
"doc"
]
},
{
"login": "gvensan",
"name": "Giri Venkatesan",
"avatar_url": "https://avatars.githubusercontent.com/u/4477169?v=4",
"profile": "https://github.com/gvensan",
"contributions": [
"talk",
"blog",
"promotion"
]
}
],
"commitConvention": "angular",
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/youtube-to-spotify-for-podcasters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
# Verify the content was written successfully
cat episode.json
- name: Upload Episode from YouTube To Anchor.Fm
uses: Schrodinger-Hat/youtube-to-anchorfm@c722f3edeee94f3173dad36c5a959247973c5253 #commit related to https://github.com/Schrodinger-Hat/youtube-to-anchorfm/commit/c722f3edeee94f3173dad36c5a959247973c5253 || The latest commit which is of Nov 14, 2023
uses: Schrodinger-Hat/youtube-to-anchorfm@b02b82f809d24db88472a78c51ffa627f46a6dc3 #commit related to https://github.com/Schrodinger-Hat/youtube-to-anchorfm/commit/b02b82f809d24db88472a78c51ffa627f46a6dc3 || The latest commit which refers to v2.4.0 of the action
env:
ANCHOR_EMAIL: ${{ secrets.ANCHOR_EMAIL }}
ANCHOR_PASSWORD: ${{ secrets.ANCHOR_PASSWORD }}
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/akkshitgupta"><img src="https://avatars.githubusercontent.com/u/96991785?v=4?s=100" width="100px;" alt="Akshit Gupta"/><br /><sub><b>Akshit Gupta</b></sub></a><br /><a href="https://github.com/asyncapi/community/commits?author=akkshitgupta" title="Documentation">πŸ“–</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/nikhilkalburgi"><img src="https://avatars.githubusercontent.com/u/70331875?v=4?s=100" width="100px;" alt="nikhilkalburgi"/><br /><sub><b>nikhilkalburgi</b></sub></a><br /><a href="https://github.com/asyncapi/community/commits?author=nikhilkalburgi" title="Documentation">πŸ“–</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gvensan"><img src="https://avatars.githubusercontent.com/u/4477169?v=4?s=100" width="100px;" alt="Giri Venkatesan"/><br /><sub><b>Giri Venkatesan</b></sub></a><br /><a href="#talk-gvensan" title="Talks">πŸ“’</a> <a href="#blog-gvensan" title="Blogposts">πŸ“</a> <a href="#promotion-gvensan" title="Promotion">πŸ“£</a></td>
</tr>
</tbody>
</table>
Expand Down
17 changes: 16 additions & 1 deletion WORKING_GROUPS.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,19 @@ working_groups:
# slack_channel: # Required. The name of the Slack channel in the AsyncAPI workspace. Example: community_growth_wg
# okrs_url: https://example.com/xyz # Required. Link to a GitHub project, issue, or any other tool where the Working Group explains their objectives.
# roadmap_url: https://example.com/xyz # Recommended. Link to a GitHub project, issue, or any other tool where the Working Group outlines their roadmap.
# github_team: # Recommended. The GitHub team handle to tag all the working group members at once. Example: @asyncapi/community_growth_wg.
# github_team: # Recommended. The GitHub team handle to tag all the working group members at once. Example: @asyncapi/community_growth_wg.
- name: Developer Experience
description: The goal of this group is to empower AsyncAPI user journey trough intuitive onboarding, tools, and a frictionless experience.
chairperson: @Amzani
members:
- @Pakisan
- @KhudaDad414
- @ivangsa
- @peter-rr
- @Shurtu-gal
- @princerajpoot20
- @Mayaleeeee
slack_channel: developer-experience-wg
roadmap_url: https://shapeit.app/projects/org/asyncapi/16
okrs_url: https://github.com/users/Amzani/projects/12/views/1
github_team: @asyncapi/developer_experience_wg
12 changes: 12 additions & 0 deletions docs/onboarding-guide/contribute-to-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Contribute to docs
weight: 70
---

## Contribute to docs

There are several ways to request your first AsyncAPI docs task:

1. **Connect with a docs maintainer:** Ask for a `good-first-issue` in the `#13_docs` channel of the [AsyncAPI Slack](https://www.asyncapi.com/slack-invite) workspace.
2. **Update current docs:** Surf the existing documentation, look for `typos`, `grammar`, `errors`, create an issue, and submit a Pull Request.
3. **Propose new docs:** If you have any ideas or suggestions for necessary documentation, [create a new docs issue](https://github.com/asyncapi/website/issues/new?labels=%F0%9F%93%91+docs&projects=&template=docs.yml&title=%5B%F0%9F%93%91+Docs%5D%3A+) and propose yourself as the assignee.
24 changes: 24 additions & 0 deletions docs/onboarding-guide/create-new-docs-directories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title : 'Create new docs directories'
weight : 80
---

### Create new docs directories
Create a new docs directory (folder) via the following steps:
1. Identify the content bucket under which your document falls.
2. Open the project locally in your code editor of choice and navigate to the parent folder.
3. Right-click on the parent folder and click "new folder".
4. Give an appropriate name to the new folder.
5. Add the following two files to the new folder:
1. `index.md`: Used as the main content for a website's directory or specific webpage. It's named index because many web servers are configured to automatically look for an index file when accessing a directory. When you access a directory on a web server, if an `index.md` file is present, it will be displayed as the default page for that directory.
2. `_section.md`: Used for reusable components or partial content within a website's structure. It defines the page's `title` and `weight`. The title defines a human-readable title, and weight controls the order in which sections (directories) are displayed.
6. You can edit the index page after successfully creating these pages.

```mermaid
flowchart LR
A[parent Folder] --> B[new Folder]
B[new Folder] --> C[index.md]
B[new Folder] --> D[_section.md]
B[new Folder] --> E[example-doc-1.md]
B[new Folder] --> F[example-doc-2.md]
```
15 changes: 15 additions & 0 deletions docs/onboarding-guide/open-docs-pull-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title : 'Create new docs pull request'
weight : 90
---

## Create a new docs pull request
Create and submit a docs pull request (PR) via the following steps:

- A Docs’ PR should solve one documentation problem.
- If there is no current issue for the docs task you want to accomplish, please open a docs issue before creating a PR.
- Use the [conventional commit style](https://github.com/asyncapi/.github/blob/master/CONTRIBUTING.md#conventional-commits) when creating PRs. Always create a docs issue or PR with the `docs:` prefix in the title.
- Please check your contribution and ensure it follows the AsyncAPI style guide.
- Tag other technical writers to review your document.
- Tag an engineer or subject matter expert (SME) to review the technical details.
- After implementing all the feedback you requested, please update your PR and wait for further feedback before it can be merged.
46 changes: 46 additions & 0 deletions docs/onboarding-guide/tools-and-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Tools and setup
weight: 60
---

## Tools for technical writers

Technical writer contributors need the following tools to contribute to AsyncAPI documentation effectively:

- A laptop or desktop computer capable of running the tools necessary to contribute to the project.
- Stable internet access to clone the project repository, submit contributions, and stay updated on project changes.
- A [GitHub](https://github.com) account. AsyncAPI hosts all its project's source code and documentation on GitHub. You'll need a GitHub account to create issues, fork the repository, submit pull requests, and more. If you're new to GitHub, familiarize yourself with [basic GitHub functionalities and workflows](https://docs.github.com/en/get-started).
- A code editor, such as [VS Code](https://code.visualstudio.com), capable of handling Markdown files.
- [Git](https://git-scm.com), a version control system.

## Setup your AsyncAPI local environment
1. Fork the repository by clicking the `Fork` option on the top right of the main repository.

2. Open Command Prompt on your local computer.

3. Clone the forked repository by adding your GitHub username instead of `<username>`.
For multiple contributions, follow the [proper configuration of a forked AsyncAPI repo](https://github.com/asyncapi/community/blob/master/git-workflow.md).

```bash
git clone https://github.com/<username>/website/
```

4. Navigate to the website directory.

```bash
cd website
```

5. Install all website dependencies.

```bash
npm install
```

6. Run the website locally.

```bash
npm run dev
```

7. Access the live development server at [localhost:3000](http://localhost:3000).
4 changes: 2 additions & 2 deletions mentorship/summerofcode/2024/asyncapi-gsoc-ideas-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Improve the [AsyncAPI website](https://github.com/asyncapi/website)'s robustness
- 🎯 **Outcome:** Achieve a stable website framework to support continuous development and updates.
- πŸ› οΈ **Skills:** JavaScript, Next.js, unit testing, and CI/CD practices.
- 🧩 **Difficulty:** Medium/Hard
- πŸ‘©πŸΏβ€πŸ« **Mentor(s):** [@akshatnema](https://github.com/akshatnema), [@anshgoyalevil](https://github.com/anshgoyalevil)
- πŸ‘©πŸΏβ€πŸ« **Mentor(s):** [@sambhavgupta0705](https://github.com/sambhavgupta0705), [@anshgoyalevil](https://github.com/anshgoyalevil)
- ⏳ **Length:** 350 Hours

## 3) [AsyncAPI Generator Maintainership](https://github.com/asyncapi/generator/issues/1145)
Expand Down Expand Up @@ -61,7 +61,7 @@ Ensure our conference website remains a dynamic and user-friendly for the upcomi
- 🎯 **Outcome:** Improve the website's efficiency and user-friendliness for an improved user experience.
- πŸ› οΈ **Skills:** JavaScript, Tailwind, and any testing framework.
- 🧩 **Difficulty:** Easy/Medium
- πŸ‘©πŸΏβ€πŸ« **Mentor(s):** [@acethecreator](https://github.com/acethecreator) [@mayaleeeee](https://github.com/Mayaleeeee)
- πŸ‘©πŸΏβ€πŸ« **Mentor(s):** [@acethecreator](https://github.com/acethecreator) [@mayaleeeee](https://github.com/Mayaleeeee) [@thulieblack](https://github.com/thulieblack)
- ⏳ **Length:** 350 Hours

## Contact AsyncAPI Mentors
Expand Down

0 comments on commit fd0a604

Please sign in to comment.