Arnold Schrijver
b5572ee602
|
||
|---|---|---|
| .github | ||
| _experiences/ideationhub | ||
| _floorplanner | ||
| _groundwork | ||
| _includes | ||
| _layouts | ||
| _plugins | ||
| _sass | ||
| _taskweave | ||
| assets | ||
| bin | ||
| docs | ||
| lib/tasks | ||
| script | ||
| .domains | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| .stylelintrc.json | ||
| 404.html | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTORS.md | ||
| Dockerfile | ||
| Gemfile | ||
| LICENSE | ||
| README.md | ||
| Rakefile | ||
| _config.yml | ||
| build.sh | ||
| docker-compose.yml | ||
| favicon.ico | ||
| index.md | ||
| just-the-docs.gemspec | ||
| package-lock.json | ||
| package.json | ||
README.md
This is Solidground Notes. Documentation website for Solidground project.
Contents
Contributing
Bug reports and pull requests are welcome. This project is intended to be a safe, welcoming space for collaboration. Please read our Code of Conduct.
We practice Social Coding Principles. By participating in our projects you consent to our Community Participation Guidelines.).
Create an issue in our Issue Tracker before you start to work on major changes, and check first if a similar issue doesn't already exist. If you want to add something entirely new, then it might be best to start a forum discussion beforehand. Be sure to post in the Solidground Matters category or one of its subcategories.
Site development
Install the prerequisites for building Jekyll websites, fork the repository to your Codeberg account and then clone that repository to your local computer.
To set up your environment for site development, first run bundle install.
To test your theme, run bundle exec jekyll serve and open your browser at http://localhost:4000. This starts a Jekyll server to preview your changes. Add pages, documents, data, etc. like normal to test your modified contents. As you make modifications to the site and its content, the site will regenerate and you should see the changes in the browser after a refresh..
When done editing and everything looks good, you can commit the changes to your Codeberg fork and create a Pull Request. Make sure that both your commit message and the PR description are succinct, clear and summarize the changes you've made.
If your PR relates to an Issue in the tracker, then mention the issue ID in the PR title between brackets e.g. "Improved accessibility (#11)".
Publishing
The site maintainers will review your PR and publish to the website when all suggested changes are accepted.
Credits
The Solidground Notes website is based on the Just-the-Docs Jekyll theme. Many thanks to Patrick Marsceill and all theme contributors, and to Codeberg for hosting great FOSS and this website.
Contributors
See the list of Contributors to the Solidground Notes website, and don't forget to add yourself to this list if you are one of them.
Code of conduct
We practice Social Coding Principles. By participating in our projects you consent to our Community Participation Guidelines.
License
Copyright (c) 2022 Solidground and contributors.
Solidground Docs are licensed AGPL-3.0 for project code, and CC-BY-SA-4.0 for documentation.