Skip to content

Latest commit

 

History

History
81 lines (51 loc) · 3.96 KB

README.md

File metadata and controls

81 lines (51 loc) · 3.96 KB

Team Wiki

OKP4 Wiki 📚

lint build publish conventional commits semantic-release contributor covenant docusaurus license cc-by-sa-4.0

🤓 About the project

Welcome to the OKP4 Wiki! This platform serves as a central repository for information about the company, its values, vision, objectives, and the processes and tools it uses for the open source projects. The goal of this project is to improve communication, transparency, and efficiency for both internal and external contributors.

💬 Support

This wiki is the perfect place to start and you will find a lot of useful information. But for any unanswered questions, for any help you may need, do not hesitate to contact us:

  • open an issue or a discussion in the most appropriate repository.
  • join us on Discord and ask your questions.

The whole team is here to help you!

🤝 Contribute

We welcome contributions from anyone who is interested in improving this wiki. Before making a contribution, please review the contributing guidelines to ensure that your contribution aligns with the project's goals and standards.

👩🏽‍💻 Develop

Prerequisites

Be sure to have the following properly installed:

Installation

To install the necessary dependencies, run the following command:

yarn

Local Development

To start a local development server, run the following command:

yarn start

This command will start a local development server and open a browser window at http://localhost:3000/. Most changes made during development will be reflected live without having to restart the server.

Please note that the search feature will not be available in development mode. To use the search feature, first run yarn build and then yarn serve.

Build

To generate static content for production, run the following command:

yarn build

This command will generate static content into the build directory and can be served using any static content hosting service.

⚖️ License

The documentation of the wiki (markdown, assets) is Creative Commons Attribution-ShareAlike 4.0 International licensed.

All other code in this repository is licensed under the 3-Clause BSD.