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.

Sign up for GitHub

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

Jump to bottom

GSoD Workspace: Reorganize the contributor guide of WasmEdge #93

Open
8 of 13 tasks
adithyaakrishna opened this issue Jun 6, 2023 · 10 comments
Open
8 of 13 tasks

GSoD Workspace: Reorganize the contributor guide of WasmEdge #93

adithyaakrishna opened this issue Jun 6, 2023 · 10 comments
Labels
gsod

Comments

@adithyaakrishna
Copy link
Contributor

adithyaakrishna commented Jun 6, 2023 •
edited
Loading

Project

  • Title: Reorganize the contributor guide of WasmEdge
  • Description: This project aims to create a contributor guide for WasmEdge to help new contributors develop plug-ins. The project involves reviewing the existing documentation and creating new guides and references for the C, C++, and Rust plug-in SDKs. The project will also update the documentation on the new Docusarus-based site, wasmedge.org/docs/. The required content for the contributor guide includes an architectural overview, getting started with contributing, building WasmEdge, testing WasmEdge, fuzzing, building a plug-in, reporting an issue, and proposing a feature request.

Detailed Description:

  • Review existing documentation: The first step is to review the existing contributor documentation to identify gaps and improvement areas. This will involve understanding the current documentation structure and content, identifying any outdated or irrelevant information, and making notes on what needs to be updated or added.
  • Create an outline: Based on the review, create an outline for the new contributor guide. This outline should cover all the required content mentioned above, with clear headings and subheadings that make it easy for new contributors to navigate and find the information they need.
  • Develop new guides and references: For each section of the outline, create new guides and references that provide clear, concise, and actionable information for new contributors. This will involve researching best practices for each topic, providing step-by-step instructions where necessary, and using clear language and visuals to make the information easy to understand.
  • Update the documentation: Once the new guides and references are complete, update the documentation on the new Docusarus-based site, wasmedge.org/docs/. This will involve creating new pages for the contributor guide, linking to relevant sections of existing documentation, and making sure that the new content is integrated seamlessly with the existing site design and structure.
  • New Features: Add a search field to the documentation through, https://docusaurus.io/docs/search such that users and visitors of the site can easily access the information that they need without going through the whole website.
  • Test and refine: Finally, test the new contributor guide with a group of new contributors to identify any remaining issues or areas for improvement. This feedback can be used to refine the guide and make it as effective as possible for new contributors.

Overall, the key to tackling this problem is to focus on creating clear and actionable information that is easy for new contributors to understand and use. By taking a structured approach to review, outlining, developing, and testing the new contributor guide, it should be possible to create a valuable resource that helps WasmEdge attract and retain new contributors.

Project Details

How does it help?

  • Easier Project Management
  • Clearer Communication
  • Maintaining Consistency
  • Easier Transfer of Knowledge
  • Easier Project Evaluation

Milestones

  • Setup basic CI and CD | Migrate to TS
  • Upgrade Docusaurus and Add Workflows
  • Add Linting Capabilites and Build Checks
  • Add Netlify which requires mentors' admin permissions
  • Gather Information and Expectations from Mentors
  • Gather information from books site to be migrated to docs site
  • Migrate books site to docs site.
  • Improve SEO
  • Remove Old Docs from https://github.com/WasmEdge/WasmEdge/tree/master/docs/book
  • Gather content to be updated across the new docs site
  • Work with mentors to add new content for the contribution guide
  • Work with mentors to add new content to the docs site
  • Add versioning capability to the project

Detailed Outline

  • Review PRs related to Docs changes: Collaborate with reviewers to review and provide feedback on PRs related to documentation changes in the WasmEdge project.
  • Theme customization: Change the overall theme of the Docusaurus site to align with the WasmEdge project colors, ensuring a consistent visual identity.
  • Contribution Guide for WasmEdge projects: Collaborate with mentors to create a comprehensive contribution guide for WasmEdge projects. Include the following sections in the contribution guide:
    • Getting started with the project
    • Cloning/Forking the project
    • Local setup
    • Contribution workflow
    • Creating PRs and working on requested changes
    • Documenting new features
    • Testing and fuzzing
  • Contributor Guide Outline:
    • Architectural overview
    • Getting started with contributing
    • Building WasmEdge
    • Testing WasmEdge
    • Fuzzing
    • Reporting an issue
    • Proposing a feature request
  • Enhancements to Documentation:
    • Add a Bots page to inform users about the bots used in the WasmEdge community.
    • Incorporate screenshots and images to make the documentation more visually appealing, particularly in sections with lengthy text-based content.
    • Include flowcharts or architecture diagrams to enhance the visual clarity of the documentation.
    • Update the landing page to improve user understanding and navigation.
  • Standardization and Compliance:
    • Add Contributing guides, License, and Code of Conduct to all WasmEdge projects, aligning them with CNCF Standards.
    • (Optional - Extended Scope) Add Interactive Video for the whole contributing flow.
  • Netlify Setup and Streamlined Workflow: Work with mentors and reviewers to set up Netlify for deploy previews, enabling a streamlined process for merging MRs related to documentation changes. (@alabulei1 Would need your help with this)
  • GitHub Actions and Automation:
    • Implement new GitHub actions to automate the labeling of PRs and issues, reducing the workload of maintainers.
    • Ensure that any content changes trigger the CI workflow, excluding the readme.md file.

Progress
@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jun 6, 2023 •
edited
Loading

Pre-GSoD Tasks - Before May 10th 2023

Description: Summary of all the work done before official GSoD period. This includes broken link fixes, spell check issues, adding new workflows. This may also include some tasks mentioned in the above proposal.

@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jun 6, 2023 •
edited
Loading

GSoD Period - May 10th to May 22nd 2023

Description: Summary of work done in the first phase of the timeline for the official GSoD period.

Expected Outcome:

  • Add linting features, coordinate with mentors to add netlify CI.
  • Migrate Docusaurus JS to TS based project

Issues & PRs

@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jun 13, 2023 •
edited
Loading

GSoD Period - May 23rd to June 10th 2023

Description: Summary of the work done in the Porting of Old Docs Phase - P1 for the official GSoD period.

Expected Outcome:

Missing Content and Redirections List - https://gist.github.com/adithyaakrishna/f19d65263cd4db7701b39676f774ab62

@alabulei1
Copy link
Collaborator

alabulei1 commented Jun 14, 2023 •
edited
Loading

Your list is great. Much appreciated. @adithyaakrishna

I can provide a detailed list of the content that has been missed and updated. See details here: https://docs.google.com/document/d/1wYOLvhuWt50M0sMPGN2TlA5JMICzv5BSczPmV4GsilQ/edit?usp=sharing

This is helpful when you migrated the new content from the old book. Let me know if you have any questions.

@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jun 14, 2023 •
edited
Loading

GSoD Period - June 11th to June 26th

Description: Summary of the work done in the Porting of Old Docs Phase - P2 for the official GSoD period.

Expected Outcome:

  • Remove Unnecessary or Unwanted Docs
  • Add note across old docs to say about content migration

Issues & PRs

@adithyaakrishna
Copy link
Contributor Author

@alabulei1 I just went through the same and it looks good to me as well! I will make sure to add them as well when working on the migration part :)

@alabulei1
Copy link
Collaborator

Hi @adithyaakrishna

WasmEdge 13.0 is released last week. One of the most important features is the unified CLI, so we should update the CLI docs on the new docs.

But there is no upcoming PRs in the last two weeks. May I ask you to update the CLI docs as soon as possible? Without corresponding docs, we can't promote the latest release to the community. Thanks.

@alabulei1 alabulei1 mentioned this issue Jul 3, 2023
Closed
@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jul 3, 2023 •
edited
Loading

GSoD Period - June 27th to July 15th 2023

Description: Summary of the work done in the Porting of Old Docs Phase - P3 for the official GSoD period.

Expected Outcome:

  • Migrate old content from Books to Docs
    • Part - 1
    • Part - 2
  • Added Eslint Parser for MD Files

Issues & PRs

Note: Work was paused for a brief period due to refactoring of docs - #135

@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Jul 25, 2023 •
edited
Loading

GSoD Period - July 15th to August 30th

Description: Summary of the work done in the Porting of Old Docs Phase - P4 for the official GSoD period.

Expected Outcome:

Issues & PRs

@alabulei1 alabulei1 added the gsod label Sep 5, 2023
@adithyaakrishna
Copy link
Contributor Author

adithyaakrishna commented Oct 27, 2023 •
edited
Loading

GSoD Period - September 1st to Present

Description: Summary of the work done during new docs phase

Expected Outcome:

  • Reviewing PRs
  • Add docs for Fuzzing
  • Add comprehensive docs for Testing
  • Update Docusaurus
  • Add contributors page
  • Added Sitemap
    • To main site
    • To docs site
  • Added plugin links

Issues & PRs

Note: Not much work was done during Sept 15th to Oct 13th due to some personal reasons and had to put this in writing here to be on the same page

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
gsod
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@adithyaakrishna @alabulei1