add profiles

Author: a-gave

.gitignore

@@ -6,5 +6,9 @@ node_modules/
 /docs/packages/**
 !/docs/packages/index.md
 
+/docs/profiles/**
+!/docs/profiles/index.md
+
+
 /lime-packages
 /network-profiles

docs/.vitepress/config.mts

@@ -11,7 +11,9 @@ const libremesh = {
   oldstable_branch_openwrt: ['19.07'],
 }
 
-const packages = await getFiles('docs/packages/*/index.md'); // Path to folder
+const packages = await getFiles('docs/packages/*/index.md');
+const profiles = await getFiles('docs/profiles/packages/*/index.md');
+const communities = await getFiles('docs/profiles/communities/*/index.md');
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -72,7 +74,6 @@ export default defineConfig({
 function nav(): DefaultTheme.NavItem[] {
   return [
     { text: 'Reference', link: '/reference/configuration' },  
-    // { text: 'News', link: '/news' },  
     { text: 'v2024.1',
       items: [
         { text: 'v2020.4', link: '/news/2023-10-07' },
@@ -121,18 +122,20 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
       text: 'Developer Guide',
       collapsed: false,
       items: [
-        { text: 'Run it on QEMU', link: '/guide/qemu' }
+        { text: 'Testing Guide', link: '/development/testing' },
+        { text: 'Run LibreMesh on QEMU', link: '/development/virtualizing' },
+        { text: 'Hacking', link: '/development/hacking' },
+        { text: 'Contributing to lime-packages', link: '/development/contributing' }
       ]
     },
     {
       text: 'Community',
       collapsed: false,
       items: [
         { text: 'Communication', link: '/communication' },
-        { text: 'Contribute', link: '/contribute' },
+        { text: 'Contributors', link: '/contributors' },
         { text: 'Meetings', link: '/meetings' },
-        { text: 'News', link: '/news' }
-
+        { text: 'News', link: '/news' },
       ]
     },
     {
@@ -153,8 +156,20 @@ function sidebarGuide(): DefaultTheme.SidebarItem[] {
     {
       text: 'Packages',
       collapsed: true,
-      link: '/packages',
-      items: generateSidebarItems(packages),
+      // link: '/packages',
+      items: [{ text: 'Table of packages', link: '/packages' }].concat(generateSidebarItems(packages)),
+    },
+    {
+      text: 'Profiles',
+      collapsed: true,
+      // link: '/profiles',
+      items: [
+        { text: 'Table of profiles', link: '/profiles' },
+        { text: 'Communities', items: generateSidebarItems(communities) },
+        { text: 'Packages', items: generateSidebarItems(profiles), },
+      ]
+
+      
     },
   ]
 }
@@ -166,7 +181,8 @@ function sidebarReference(): DefaultTheme.SidebarItem[] {
       text: 'Reference',
       items: [
         { text: 'Configuration', link: 'configuration' },
-          { text: 'Flavors', link: '/reference/flavors' },
+        { text: 'lime-config', link: 'lime-config' },
+        { text: 'Flavors', link: '/reference/flavors' },
         { text: 'lime-files', items: [
           { text: 'System options', link: 'system' },
           { text: 'Network options', link: 'network/', items: [

docs/changelog.md

@@ -1,4 +1,4 @@
-# Contributions
+# Contributors
 
 LibreMesh is a community and an open project, so anyone friendly is welcome.    
 We encourage anyone using the LibreMesh to become part of this community.    

docs/contribute.md docs/contributors.mddocs/contribute.md renamed to docs/contributors.md

@@ -0,0 +1,177 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Forks and Pull Requests
+
+Development on lime-packages follows the Fork and Pull Request method popularized by GitHub:
+
+- Every contributor has their own complete copy, called a *Fork*
+- Contributors implement features or fix bugs on their own fork in a feature branch.
+- When the contributor wants to integrate their changes back into the main repository,
+  they will create a *Pull Request*.
+
+Each of these steps will be discussed in turn:
+
+#### Forking
+
+The first thing that you will need for development, is to create a new copy of the repository to
+work on.  This is known as "Forking" and is a defining characteristic of distributed
+SCM systems: each person works on their own complete copy of the repository.  Git is designed to
+make it trivially easy to keep these repositories in sync by passing signed revisions amongst the
+individual copies.
+
+In order to create a fork:
+
+1. Log into GitHub and go to the [lime-packages GitHub repository](https://github.com/libremesh/lime-packages).
+
+2. Click "Fork".  You should be redirected to a complete copy of the repository which now resides in your account.
+
+3. On your workstation, create a clone of the Git repository:
+    ```git clone git@github.com:<your-username>/lime-packages.git```
+    This will create yet another complete copy of the repository: one that will reside
+    on your workstation.
+
+4. Checkout the `master` branch.
+   ```git checkout master```
+
+### Branching
+
+Any changes that are made to the lime-packages code-base should be done in their own branch.  The branch
+should be made from the tip of `master`, which is the development branch.  Before starting
+any piece of work, ensure that you fetch the latest upstream changes from the repository.
+Doing so will ensure that you have an up-to-date copy of `master`, that changes made by others
+will not be lost, and will also reduce the chances of conflicts when it comes time to merging the
+changes back to lime-packages.
+
+#### Branch Names
+
+There is only one key branch:
+
+- `master`: this branch is the working version that is currently under development.  All
+    new feature branches should be made from the tip of `master` and all PR's should have `master`
+    set as the target.
+
+For any new feature branches, the following naming convention is recommended:
+
+### `<type>/<name>`
+
+#### `<type>`
+```
+issue     - Code changes linked to a known issue.
+feature   - New feature.
+hotfix    - Quick fixes to the codebase.
+sandbox   - Experiments (will never be merged).
+```
+
+#### `<name>`
+Always use dashes to seperate words, and keep it short.
+
+##### Examples
+```
+issue/133
+feature/smonit
+hotfix/driver-xxx
+sandbox/new-crazy-thing
+```
+
+#### General Workflow
+
+The general workflow for branching is as follows:
+
+1. Fetch the latest changes from `upstream` (i.e. the main repository):
+
+   ```git fetch upstream master```
+
+2. Check-out you copy of `master` and merge the upstream changes:
+
+    ```git checkout master```
+    
+    ```git merge upstream/master```
+
+    You now have an up-to-day copy of the `master` branch.
+
+3. Create a new branch for your changes:
+
+    ```git checkout -b <branch name>```
+
+4. Run the tests: read [[Testing docs](testing)].
+
+5. Make your changes, we encourage you to try to add a test.
+
+6. Make sure the tests are still running with success.
+
+7. Push the changes to `origin` (i.e. your fork)
+
+    ```git push origin <branch name>```
+
+8. Create a new Pull Request (see below).
+
+#### Creating A Pull Request
+
+In order to integrate your changes into the main lime-packages repository, you will
+need to create a *Pull Request* in GitHub.
+
+1. Log into GitHub and go to your fork of lime-packages.
+
+2. Click "New Pull Request"
+
+3. Make sure that the following properties are set:
+
+    - Base fork = `libremesh/lime-packages`
+    - Base = `master`
+    - Head fork = your fork of lime-packages
+    - Compare = the branch you wish to merge
+
+4. Add a description of what the change is and click "Create Pull Request".
+
+At this point, it is recommended to notify one of the other developers of the 
+pull request and ask them to perform a quick review.  They will make any comments
+in the pull request itself, which you should receive as GitHub notifications or as
+emails.
+
+Once the reviewer has OK the pull request, and GitHub has indicated that it can
+be merged automatically, you are free to merge the pull request.
+
+#### Dealing With Conflicts
+
+Sometimes GitHub will report that the Pull Request cannot be merged automatically,
+which usually means that there are merge conflicts.
+
+It is usually a good idea to resolve the conflicts on the branch you are working on,
+rather than doing so on `master`.
+
+In order to do so:
+
+1. Fetch the latest changes from the upstream `master` branch
+
+    ```git fetch upstream master```
+
+2. Make sure that you are on your feature branch.
+
+3. Merge the upstream changes into master.  You will see "conflict messages"
+
+    ```git merge upstream/master```
+     
+4. Use a merge tool to resolve the conflicts.  If one is configured with Git,
+    running `git mergetool` should bring it up.  Some GUI tools like 
+    [this](https://git-scm.com/download/gui/linux) have one built in.
+
+5. Ensure that the merge was successful by building and testing the changes.
+
+6. Commit the changes and push to origin.
+
+     ```git commit```
+
+     ```git push origin <branch>```
+
+If you have a Pull Request already pending, GitHub should pick up the recent
+changes and indicate that the PR is ready to be merged.
+
+
+### More Information
+
+For more information, please see [Collaborating on projects using issues and pull requests](https://help.github.com/categories/collaborating-on-projects-using-issues-and-pull-requests/) in the GitHub help guide.

docs/development/contributing.md

@@ -0,0 +1,22 @@
+
+
+## Remote debugging Lua code mini-howto
+
+ZeroBrane Studio, an OpenSource Lua IDE https://studio.zerobrane.com/, has awesome remote debugging
+capabilities https://studio.zerobrane.com/doc-remote-debugging
+
+If you have the code you want to debug, you just need to add the following line
+
+```lua
+require('mobdebug').start("10.5.5.140")
+```
+and it will connect to your computer (being `10.5.5.140` your computer) and will allow you to go step
+by step, dump variables, etc.
+
+For this to work you need to install two packages on the router: luasocket and lua-mobdebug
+
+```
+root@LiMe-abcd00:/# opkg update
+root@LiMe-abcd00:/# opkg install luasocket lua-mobdebug
+```
+