Skip to content

docs: new intro page#1384

Merged
OmarBrbutovic merged 1 commit intoedgehog-device-manager:mainfrom
lusergit:push-vqxwnwlvxpln
Apr 23, 2026
Merged

docs: new intro page#1384
OmarBrbutovic merged 1 commit intoedgehog-device-manager:mainfrom
lusergit:push-vqxwnwlvxpln

Conversation

@lusergit
Copy link
Copy Markdown
Collaborator

@lusergit lusergit commented Apr 21, 2026

What this PR does / why we need it:

Revises the introductory page for the project, displaying

  • License and version
  • An overview of the project's functionalities
  • Entrypoints for APIs, (both admin && tenant)
  • A guide on how to read documentation

Additional documentation e.g. usage docs, diagrams, reviewer notes, etc.:

Screenshots Screenshot From 2026-04-21 15-01-05 Screenshot From 2026-04-21 15-01-10 Screenshot From 2026-04-21 15-01-18

Thanks for sending a pull request! If this is your first time, here are some tips for you:
  1. You can take a look at our developer guide for an introduction on Edgehog development!
  2. Make sure to read CONTRIBUTING.md and CODE_OF_CONDUCT.md
  3. If the PR is unfinished or you're actively working on it, mark it as draft

When fixing existing issues, use github's syntax to link your pull request to it

fixes #<issue number>

We also have a syntax to signal dependencies to other open pull requests

depends on #<pr number>
depends on https://github.com/...

In case of stacked PRs, you may add the PR number in the last commit's title instead:

gitGraph
    commit id: "Current master"
    branch feat1
    checkout feat1
    commit id: "feat: add something"
    commit id: "feat: add something else (#100)"
    branch feat2
    checkout feat2
    commit id: "refactor: do something"
    commit id: "fix: solve issue"
    commit id: "feat: add a feature (#101)"
    branch feat3
    checkout feat3
    commit id: "feat: feat without pr number"
Loading

@lusergit lusergit force-pushed the push-vqxwnwlvxpln branch 3 times, most recently from 286601c to dc235c3 Compare April 21, 2026 13:31
@lusergit lusergit force-pushed the push-vqxwnwlvxpln branch from dc235c3 to 068101a Compare April 21, 2026 14:45
Comment thread backend/docs/pages/intro/intro.md Outdated
@lusergit lusergit force-pushed the push-vqxwnwlvxpln branch from 068101a to 2f3221d Compare April 22, 2026 12:04
@lusergit lusergit force-pushed the push-vqxwnwlvxpln branch from 2f3221d to 822a38a Compare April 22, 2026 12:25
id: compute-version
run: |
version=$(${{ inputs.release-made }} && echo ${{ inputs.release-version }} || echo "snapshot")
echo "version=$version" >> $GITHUB_OUTPUT
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On a pull_request run, inputs.release-made / inputs.release-version are not defined (they only exist for workflow_call). Replace the step with an expression-based assignment that works both for PRs and workflow_call:

Suggested change
- name: Compute docs version
id: compute-version
run: |
echo "version=${{ inputs.release-made && inputs.release-version || 'snapshot' }}" >> "$GITHUB_OUTPUT"

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I choose to revert the changes, but indeed this is meaningful

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addressed in #1391

Comment thread backend/docs/pages/intro/intro.md Outdated
Comment thread backend/docs/pages/intro/intro.md Outdated
Comment thread backend/docs/pages/intro/intro.md
Comment thread backend/docs/pages/intro/intro.md
Comment thread backend/docs/pages/intro/intro.md
Comment thread backend/docs/pages/intro/intro.md Outdated
@lusergit lusergit force-pushed the push-vqxwnwlvxpln branch from 822a38a to 0d3ba5d Compare April 23, 2026 09:01
Revises the introductory page for the project, displaying

- License and version
- An overview of the project's functionalities
- Entrypoints for APIs, (both admin && tenant)
- A guide on how to read documentation

Signed-off-by: Luca Zaninotto <luca.zaninotto@secomind.com>
@OmarBrbutovic
Copy link
Copy Markdown
Collaborator

/fast-forward

@edgehog-app
Copy link
Copy Markdown

edgehog-app Bot commented Apr 23, 2026

Triggered from #1384 (comment) by @​OmarBrbutovic.

Trying to fast forward main (6231376) to push-vqxwnwlvxpln (af82c4e).

Target branch (main):

commit 6231376345bca53231347533b7764b191a67a222 (HEAD -> main, origin/main)
Author: Omar <omar.brbutovic@secomind.com>
Date:   Mon Apr 13 11:07:41 2026 +0200

    refactor: Move file compression to backend and support larger uploads
    
    - Switched file hashing to chunked streaming to prevent frontend memory
    exhaustion on `>2GB` uploads
    - Added backend-aware upload headers (omit x-ms-blob-type for S3 URLs)
    - Added support for archive encoding for multiple file uploads
    
    Signed-off-by: Omar <omar.brbutovic@secomind.com>

Pull request (push-vqxwnwlvxpln):

commit af82c4e776dacb637109de6bf351cca718f0ae79 (pull_request/push-vqxwnwlvxpln)
Author: Luca Zaninotto <luca.zaninotto@secomind.com>
Date:   Tue Apr 21 11:15:40 2026 +0200

    docs: revise intro page
    
    Revises the introductory page for the project, displaying
    
    - License and version
    - An overview of the project's functionalities
    - Entrypoints for APIs, (both admin && tenant)
    - A guide on how to read documentation
    
    Signed-off-by: Luca Zaninotto <luca.zaninotto@secomind.com>

Can't fast forward main (6231376) to push-vqxwnwlvxpln (af82c4e). main (6231376) is not a direct ancestor of push-vqxwnwlvxpln (af82c4e). Branches appear to have diverged at 9df1b0e:

* af82c4e776dacb637109de6bf351cca718f0ae79 docs: revise intro page
| * 6231376345bca53231347533b7764b191a67a222 refactor: Move file compression to backend and support larger uploads
| * 100e66cc8948ec59f3b5f5e437970cdaeca5a6d8 refactor: expand file transfer capabilities
|/  
* 9df1b0e525165e02aff77aa0c2bd7dae0afbbfdf chore(deps): update dependency tesla to ~> 1.17 (#1389)

commit 9df1b0e525165e02aff77aa0c2bd7dae0afbbfdf
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Wed Apr 22 08:30:42 2026 +0000

    chore(deps): update dependency tesla to ~> 1.17 (#1389)
    
    | datasource | package | from   | to     |
    | ---------- | ------- | ------ | ------ |
    | hex        | tesla   | 1.17.0 | 1.17.0 |
    
    Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Rebase locally, and then force push to push-vqxwnwlvxpln.

@OmarBrbutovic OmarBrbutovic merged commit 3093dba into edgehog-device-manager:main Apr 23, 2026
19 checks passed
@lusergit lusergit deleted the push-vqxwnwlvxpln branch April 23, 2026 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants