Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
S
spec
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 2
    • Merge Requests 2
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • retribute.me
  • spec
  • Merge Requests
  • !2

Open
Opened Oct 24, 2019 by Agate@agate💬Owner0 of 6 tasks completed0/6 tasks
  • Report abuse
Report abuse

Check out, review, and merge locally

Step 1. Fetch and check out the branch for this merge request

git fetch origin
git checkout -b "profiles-spec" "origin/profiles-spec"

Step 2. Review the changes locally

Step 3. Merge the branch and fix any conflicts that come up

git fetch origin
git checkout "master"
git merge --no-ff "profiles-spec"

Step 4. Push the result of the merge to GitLab

git push origin "master"

Note that pushing to GitLab requires write access to this repository.

Tip: You can also checkout merge requests locally by following these guidelines.

WIP: Retribute Profiles Spec, initial draft

  • Overview 1
  • Commits 1
  • Pipelines 2
  • Changes 1

Human-readable version at https://dev.funkwhale.audio/retribute.me/spec/blob/profiles-spec/specs/retribute-profiles-format.md

I don't expect to merge this anytime soon, but I feel like it was needed to write this down to start the discussion. I'd gladly accept any review, comments and feedback!

This second spec aims at specifying the creator's side of things. The idea is to standardize how Retribute clients retrieve Retribute information, and donation links in particular, once they have suggestions.

I'd probably recommend doing your first reading at https://dev.funkwhale.audio/retribute.me/spec/blob/suggestions-spec/specs/suggestions-feed-format.md, the Suggestions feed specification at !1, and use the review interface for typos/suggestions afterwards :)

Todo:

  • Pick a format (JSON-LD, Plain JSON, something else) to represent the data
  • Document all the properties (weight, url, providel, avatar, summary, etc.)
  • Document (or at least mention) hubs
  • Write a PoC in Python (https://github.com/scrapinghub/extruct seems a good candidate) to play with exemples and real websites
  • Add a section about security/identity considerations (to avoid following links you shouldn't, this kind of things)
  • Everything else
Edited Oct 24, 2019 by Agate
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
Reference: retribute.me/spec!2
Source branch: profiles-spec