Code Monkey home page Code Monkey logo

website's Introduction

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/website.git
cd website

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 preview_build
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 including the latest pre-release documention from enarx/enarx project, run the following command:

yarn preview_build

Alternatively, to build the website including the latest released enarx/enarx project, run the following command:

yarn production_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

website's People

Stargazers

avatar avatar avatar avatar

Watchers

avatar avatar avatar avatar avatar avatar

Forkers

platten deepansharora27 bstrie moksh-pathak haraldh pranavpeshwe fienne puiterwijk dpal swatishree-mahapatra hynecn maveraw thalesgroup rjzak

website's Issues

[Feature]: Create link to Codex repo

Is there an existing issue for this?

  • I have searched the existing issues

Description

For each language from WebAssembly guide, create a link to Codex repo.

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: Documentation available online for using enarx CLI

Is there an existing issue for this?

  • I have searched the existing issues

Description

It would be great to have enarx cli reference materials published on enarx.dev

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: Add practices folder

Is there an existing issue for this?

  • I have searched the existing issues

Description

As the project matures, we need to capture different practices we adopt and make them a part of the project-related documentation.

This issue calls for creating a "Practices" folder in the "website" repository. The folder is where we will store documents describing "how we do what we do".

Acceptance Criteria

  • Foder is created
  • At least one active document is uploaded

Suggestions for a technical implementation

No response

[Bug]: Broken link in docs

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

  1. In the Installation guide, the Install Enarx from the source is not editable. The reason being the path is not added to the main. It throws an error on editing like this:
    image

  2. Also, there is one more link that doesn't work. It throws the same 404 error because the Linux repo of the Enarx website has no folder named "tree".
    image

Expected Behaviour

  1. The Install md should be editable and the link must lead to its GitHub page origin.

  2. The link for running the Linux Kernel from patches might have been transferred to some other repository. The correct link of the path should be added.

Environment Information

image

Steps To Reproduce

No response

[Feature]: Add images to documentation

Is there an existing issue for this?

  • I have searched the existing issues

Description

Add graphical explanation of core concepts to better explain the idea/working of Enarx.

Images can be found here: https://github.com/enarx/designs

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: More details around SGX configuration for new users, installations

Is there an existing issue for this?

  • I have searched the existing issues

Description

The website is light on details as to how to get a system running with SGX dependencies so that Enarx can be used.

Acceptance Criteria

Someone should be able to sit down at a new SGX machine, be able to follow the instructions, and be able to run an Enxarx job in SGX.

Suggestions for a technical implementation

  • Show how to enable SGX in the BIOS
  • Show how to find and install SGX requirements
  • Show how to install and run aesmd

[Feature]: <Platform language Support>

Is there an existing issue for this?

  • I have searched the existing issues

Description

To be able to convert the Enarx Documentation in various languages. So that people learning our project may have ease in translating it.

Acceptance Criteria

Do we follow up with these commitments??

  • Developing an experience tailored to users of different regions/language.
  • Creating, reviewing and maintaining newly written content for different users of the site?
  • Supporting customers in a new region and /or language?

Suggestions for a technical implementation

Tranlation with the help of Docusaurus v2

[Feature]: Download Enarx link on the front page

Is there an existing issue for this?

  • I have searched the existing issues

Description

From @MikeCamel:

Visiting https://enarx.dev/, there's no "download" link to allow me to download pre-compiled Enarx binaries, which would help for people wanting to use the Drawbridge option with try.enarx.dev. I also couldn't see an obvious route to downloading one from the GitHub main page. We do provide these, right?

Acceptance Criteria

Provide a download link on the front page, perhaps on the title bar on the top, with a link to https://github.com/enarx/enarx/releases

Suggestions for a technical implementation

No response

[Bug]: YouTube links in Repo Guide not working

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

All of YouTube links in the Enarx repo guide are not working (video marked as not available).

Expected Behaviour

The videos are available.

Environment Information

Not relevant

Steps To Reproduce

No response

[Bug]: Clean Profian mentions and infrastructure use

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

A lot of Profian mentions are scattered all around the docs, along with some tutorials using Profian infrastructure that is not running anymore.

Expected Behaviour

The docs explained what Profian is and what happened to it, the mentions to Profian are cleaned and / or explained, and the tutorials using Profian infrstructure are updated.

Environment Information

not relevant

Steps To Reproduce

No response

[Bug]: Swift example is incomplete

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

On https://enarx.dev/docs/WebAssembly/Swift:

The command docker run --rm -it ghcr.io/swiftwasm/swift:latest /bin/bash does not expose the current working directory to the Docker container, so the Swift source file isn't available in the container for the compiler.

Expected Behaviour

Instead, should be:

  • Run Docker (note -v)
docker run -v `pwd`:/swift --rm -it ghcr.io/swiftwasm/swift:latest /bin/bash
  • In the container, run:
swiftc -target wasm32-unknown-wasi /swift/fibonacci.swift -o /swift/fibonacci.wasm
  • When done, you'll have:
file fibonacci.wasm 
fibonacci.wasm: WebAssembly (wasm) binary module version 0x1 (MVP)

Environment Information

N/A

$ uname -a
Linux 5.15.0-41-generic #44~20.04.1-Ubuntu SMP Fri Jun 24 13:27:29 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
$ enarx --version
enarx 0.5.1

Steps To Reproduce

No response

[Bug]: Copy button copies shell prefix `$` inside of code blocks

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

Copy button copies shell prefix $ inside of code blocks

Expected Behaviour

Either shell prefix should be removed, or alternatively copy button should copy everything except the shell prefix.

Environment Information

Current enarx.dev website

Steps To Reproduce

  1. Navigate to: https://enarx.dev/docs/Installation/Setup#fedora
  2. Click on the copy button on the right side of the code block
  3. Paste output in text editor.

[Feature]: Add SEV-SNP + SGX BIOS Configuration Guide

Is there an existing issue for this?

  • I have searched the existing issues

Description

Add guide which outlines which settings need to be enabled/set in the BIOS to have SGX or SEV-SNP working on physical hardware.

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: Discuss Ruvy on the Ruby page

Is there an existing issue for this?

  • I have searched the existing issues

Description

Ruvy is a new toolkit which makes it easier to make WebAssembly builds for Ruby projects. More info in the blog post.

Acceptance Criteria

Discuss Ruvy and show a simple demo.

Suggestions for a technical implementation

No response

[Feature]: create WebAssembly Matrix

Is there an existing issue for this?

  • I have searched the existing issues

Description

Currently the WebAssembly matrix on the WebAssembly Guide is very rudimentary:

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

We want to expand this matrix to provide more information, including:

  • WASI support (this has to be tested)
  • Enarx support (how well it works)
  • Enarx support tier (prioritized support, etc - inspired by Rust tiers)
  • Notes with comments

This matrix should be grouped by support tier/level and then Tiobe index. We can color code the rows into support tiers: green yellow red, or gold silver bronze.

Seek collaboration with Fermyon:

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

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

[Feature]: Add Java example

Is there an existing issue for this?

  • I have searched the existing issues

Description

We want to add a Java example to the WebAssembly Guide.

This is related to issue enarx-archive/enarx.github.io#93, but we want to give priority to it.

@Deepansharora27 is leading this initiative, and any help is welcome. Please get in touch.

Acceptance Criteria

No response

Suggestions for a technical implementation

No response

doc: update IntelSGX

Is there an existing issue for this?

  • I have searched the existing issues

Description

Currently, the information in the IntelSGX system seems inadequate. In order for beginners to have a better understanding, we will add more information to the documentation. Hence making it more understandable.

Acceptance Criteria

No response

Suggestions for a technical implementation

Will use some pictorial representation for a better understanding.

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.