Git Product home page Git Product logo

enarx.github.io's Introduction

โ— This repository has been archived and moved to enarx/website.

Enarx website & documentation

This repository contains the assets required to build the Enarx website and documentation. We're glad that you want to contribute!


Prerequisites

To install the website locally and build it, you need the following installed:

Before you start, install the dependencies. Clone the repository and navigate to the directory:

git clone https://github.com/enarx/enarx.github.io.git
cd enarx.github.io

The Enarx website uses Docusaurus to build a customizable and optimized website.


Running the website

To install the project dependencies, run the following command:

yarn install

To start a local development server, run:

yarn start

This starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.


Building the website

To build the website, run the following command:

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service. You can run the following command to serve the build:

yarn serve

Contributing to the website

Click the Fork button in the upper-right area of the screen to create a fork of this repository in your GitHub account. Create a branch off the main and make any changes you want in your fork. Create a new pull request to help us know about your proposed changes so that we can provide actionable feedback. As a pull request owner, it is your responsibility to modify your pull request to address the feedback that has been provided to you by the reviewer.

After all the comments are addressed, please let us know and we will merge your pull request. Contributions are welcome to make our documentation more accessible and readable, adding new features to help a wider audience know about Enarx and help onboard new contributors and users.

Participation in the Enarx community is governed by the Contributor Covenant Code of Conduct.

You can engage with us on the following channels:


License

MIT License

enarx.github.io's People

Contributors

aryankaushikdev avatar axelsimon avatar ayush7614 avatar bstrie avatar deepansharora27 avatar definitelynobody avatar dependabot[bot] avatar gdetrez avatar haraldh avatar harshcasper avatar jnyfah avatar lkatalin avatar mayankkumar2 avatar mbestavros avatar mikecamel avatar moksh-pathak avatar nickvidal avatar npmccallum avatar platten avatar rjzak avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

enarx.github.io's Issues

Provide demo videos in mp4

We need to provide the videos in multiple formats, as not everyone's default browser reads webm directly.

So encode the videos to h264 in an mp4 container and add them to the assets/video directory.

[Bug]: <title> updating (doc) WebAssembly with Rust

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct

Current Behaviour

image

Expected Behaviour

getting error like release folder not found.

Environment Information

uname -a; enarx --version; enarx info

Steps To Reproduce

No response

[Feature]: C/C++ demos for non-Windows developers

Is there an existing issue for this?

  • I have searched the existing issues

Description

The tutorials for C/C++ are oddly Windows-centric. Despite some instructions for compiling with gcc, g++ on Linux, the instructions point users to https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-170

Acceptance Criteria

The introductions should break-down the instructions by operating system. The wasi-sdk supports Linux & macOS.

  • Instructions for mac OS (install Xcode, for example)
  • Instructions for Linux (use your package manager to install clang, for example)

Suggestions for a technical implementation

No response

[Feature]: Support enarx release-specific versions of enarx.dev

Is there an existing issue for this?

  • I have searched the existing issues

Description

As there will be more documentation upcoming around features documented in enarx, it would be useful to have the site support multiple versions. This could also be helpful in installing the appropriate version in the install section, as well as help keeping the documentation in lock step with currently supported and unreleased enarx version. This would also allow the Install documentation to be different depending if you are installing from git or from published crates.

Acceptance Criteria

  • Design/proposal created
  • Buy in from team
  • Implementation of content
  • Update in release automation

Suggestions for a technical implementation

An example of this could be found here.

[Feature]: Augment contributor documentation with requirements around conventional commits

Is there an existing issue for this?

  • I have searched the existing issues

Description

With the newly enabled GitHub actions enforcing conventional commits, it is critical to provide appropriate guidance to the developer community on how to contribute content.

Acceptance Criteria

Update https://enarx.dev/docs/Contributing/PRs section of the website with the appropriate material around commit messages (as well as GitHub PR titles).

Suggestions for a technical implementation

Please take a look at: https://github.com/dracutdevs/dracut/blob/master/docs/HACKING.md#commit-messages for inspiration.

Official spec here: https://www.conventionalcommits.org/en/v1.0.0/#summary

Choose a site generator for the blog

Original issue by @axelsimon:

Building the enarx.github.io landing page requires us to choose which tool we want to use to power the page / site.

@shaunix was telling me Jekyll is used in OSPO but only as a default, not a mandate.

I've also heard good things about Pelican (which I've played with a bit) and Hugo.

These are the choices that come to mind, any advice is welcome.

I'd like to settle on one of them quickly so we can then build a minimal but useful site.

Acceptance criteria: We have agreed on a site generator.

Standardize Bug & Feature Request Issue Templates

Description:

  • Ensure that process around filing bugs and requesting new issues is standardized across repositories.
  • Provide standardized issue filing landing page
  • Add triage label, and automatically tag new issues with this label for triage.

[Bug]: Update documentation to require users to use rust nightly

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct

Current Behaviour

Due to inline asm feature not rolled out in rust stable, we need to update the documentation to ensure that users build enarx using the rust nightly to avoid compile time errors.

Expected Behaviour

Successful compilation and installation of enarx with the posted instructions.

Environment Information

Rust stable 1.58.1

Steps To Reproduce

  1. Follow Install from Github section from: https://enarx.dev/docs/Installation/Enarx
  2. Use the rust stable toolchain

Create WebAssembly Guide with various languages

Is there an existing issue for this?

  • I have searched the existing issues

Description

We want to create a WebAssembly Guide with a simple example using various programming languages that currently have support for WASI:

https://enarx.dev/docs/WebAssembly/Introduction

Fermyon has a good matrix showing languages that support WASI:

https://www.fermyon.com/wasm-languages/webassembly-language-support

Among these languages, recently we saw JavaScrip/TypeScript getting support:

https://blog.suborbital.dev/bringing-javascript-and-typescript-to-suborbital

Acceptance Criteria

The languages we are interested in are the following, currently ordered by their support of WASI and importance:

  • Rust
  • C
  • C++
  • Go
  • JavaScript
  • TypeScript
  • AssemblyScript
  • .NET
  • Ruby
  • Grain
  • Zig
  • Python
  • Swift
  • Kotlin
  • Java
  • Erlang
  • Haskell
  • Lisp
  • COBOL

Suggestions for a technical implementation

We are thinking in using Fibonacci as an example:

https://github.com/enarx/outreachy/tree/main/Jennifer/Rust-to-WASI

If you are interested in contributing, please:

  • Implement Fibonacci in your language of choice
  • Add a markdown file to docs/WebAssembly
  • Add a sidebar link at sidebars.js
  • Create a PR against this repo

Thank you!

[Feature]: Edit and post link to Enarx code walkthrough

Is there an existing issue for this?

  • I have searched the existing issues

Description

It would be helpful to edit and post @npmccallum's Enarx project code walkthrough video and make it easily consumable.

Acceptance Criteria

  • Break apart into sub-videos
  • Remove crosstalk/digressions/non-enarx related discussions
  • Add sub-video topic splash graphic containing enarx logo & section title.
  • Add opening and closing enarx project splash graphic (to first video and the last)
  • Create draft blog post providing overview to video series along with private youtube playlist for review
  • Approval/signoff by @npmccallum and/or @MikeCamel
  • Publish playlist & document/TOC in blog and/or post for full walkthrough

Suggestions for a technical implementation

No response

[Feature]: Pull installation instructions from enarx source code

Is there an existing issue for this?

  • I have searched the existing issues

Description

Installation instructions should be stored along with the enarx source code and embedded in the documentation during CI.

Acceptance Criteria

  • Update GH actions to dynamically update the installation page from INSTALL.md
  • Create GithHub action to update just the installation page using using a repository_dispatch trigger event which would be triggered by a workflow on in the enarx/enarx following a published release event.

Suggestions for a technical implementation

Example of cross repository automation: https://ayeshahansi.medium.com/trigger-your-test-automation-project-through-the-workflow-of-the-application-cross-repository-58759aa82d15

Overhaul Filling Issues Documentation

Description:

The current bug filling documentation requires an overhaul to ensure that the issue filing process is the coherent. This task is related to: enarx/.github#11 (comment)

Acceptance Criteria

  • Rename Bugs to "Filing Issues"
  • Add triage label to list of available labels
  • Provide information about filing a bug
  • Provide information about how to request a feature or enhancement

[Feature]: Add Algolia Search

Is there an existing issue for this?

  • I have searched the existing issues

Description

Docusaurus has official support for Algolia DocSearch. The service is free for any open-source project. Enarx applied to the DocSearch program and got accept (2nd round). We now need to make the necessary configurations to have this search functionality on our website.

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: Bump docusaurus to 2.0.0-beta.16

Is there an existing issue for this?

  • I have searched the existing issues

Description

Update docusaurus from 2.0.0-beta 15 to 2.0.0-beta.16.

Acceptance Criteria

No response

Suggestions for a technical implementation

yarn upgrade @docusaurus/core@latest @docusaurus/preset-classic@latest

[Bug]: Remove mention of `cargo make ci-flow` from PRs section of the documentation.

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct

Current Behaviour

As we no longer rely on cargo make we should update the section for running the unit tests under the following url: https://enarx.dev/docs/Contributing/PRs#check-that-your-code-is-really-ready

Expected Behaviour

Documentation reflects build process.

Environment Information

Does not apply.

Steps To Reproduce

No response

[Feature]: Instructions for reporting issues with lab machines

Description:

Users should be provided with instructions on how to report issues with lab machines to ensure infrastructure issues are addressed as soon as possible.

Proposed Implementation:
Post instructions on enarx.dev website in the "Lab Machines" section. Instructions should include filing an issue on the https://gitlab.com/enarx/lab repository and optionally notifying the team on the infrastructure channel in Rocket.Chat.

Consistent format of demo videos

The .gifs and .webms of SGX and SEV currently look different. I'm not sure how the SEV one was created, so am having trouble reproducing it. At some point, we should make them look more similar.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.