Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: updates to Integration and Administration section in Rafiki user docs #3139

Open
5 of 6 tasks
melissahenderson opened this issue Nov 27, 2024 · 1 comment
Open
5 of 6 tasks

docs: updates to Integration and Administration section in Rafiki user docs #3139

melissahenderson opened this issue Nov 27, 2024 · 1 comment
Assignees
@melissahenderson
Labels
user-doc-priority: medium User doc priority is medium user-docs

Comments

@melissahenderson
Copy link
Contributor

melissahenderson commented Nov 27, 2024 •
edited by brad-dow
Loading

After the team spoke with Max yesterday, we decided to make a few changes to the Rafiki IA.

Brad is working on a peering integration doc, so some items A.) can't be complete until #2967 is done and/or B.) will be taken care of as part of 2967.

  • Place the peering integration doc within the Integration > Requirements section.
  • Create a new section in Integration, called Deployment, and move the "Docker Compose" and "Helm and Kubernetes" pages into the section.
  • Move Integration > Services so that it's a subsection of Deployment (e.g., Integration > Deployment > Services > auth service).
  • The content in the "Manage peering relationships" page should become part of Brad's peering integration page. The "Manage" page should go away.
  • Split the "Manage Liquidity" page in Administration into multiple pages. Have a section under Administration called either "Liquidity" or "Manage Liquidity". Within that section, have separate pages for Asset liquidity, Peer liquidity, Payment liquidity, and Two-phase withdrawals.
  • Update the sidenav's TOC as needed.
@github-project-automation github-project-automation bot moved this to Backlog in Rafiki Nov 27, 2024
brad-dow added a commit that referenced this issue Dec 6, 2024
@brad-dow
docs: peering integration guide
a02e32a 
Initial draft (repurposed the manging peering relationships admin page into a technical integration guide)
Completed a few tasks from #3139 as well, including the following:
- Place the peering integration doc within the Integration > Requirements section.
- Create a new section in Integration, called Deployment, and move the "Docker Compose" and "Helm and Kubernetes" pages into the section.
- Move Integration > Services so that it's a subsection of Deployment (e.g., Integration > Deployment > Services > auth service).
- The content in the "Manage peering relationships" page should become part of Brad's peering integration page. The "Manage" page should go away.
- Update sidenav's TOCs as needed
@brad-dow brad-dow mentioned this issue Dec 6, 2024
Merged
@brad-dow
Copy link
Contributor

brad-dow commented Dec 6, 2024

The items checked in the description are taken care of in this PR: #3166

This issue basically turns into "split 'Manage Liquidity' into multiple pages"

@melissahenderson melissahenderson moved this from Backlog to Todo in Documentation Dec 9, 2024
@melissahenderson melissahenderson moved this from Todo to Backlog in Documentation Dec 9, 2024
@melissahenderson melissahenderson moved this from Backlog to Todo in Documentation Dec 9, 2024
@melissahenderson melissahenderson self-assigned this Dec 9, 2024
@melissahenderson melissahenderson moved this from Todo to In Progress in Documentation Dec 12, 2024
brad-dow added a commit that referenced this issue Dec 17, 2024
@brad-dow
docs: peering integration guide (#3166)
45898f7 
* docs: peering integration guide

Initial draft (repurposed the manging peering relationships admin page into a technical integration guide)
Completed a few tasks from #3139 as well, including the following:
- Place the peering integration doc within the Integration > Requirements section.
- Create a new section in Integration, called Deployment, and move the "Docker Compose" and "Helm and Kubernetes" pages into the section.
- Move Integration > Services so that it's a subsection of Deployment (e.g., Integration > Deployment > Services > auth service).
- The content in the "Manage peering relationships" page should become part of Brad's peering integration page. The "Manage" page should go away.
- Update sidenav's TOCs as needed

* Updated broken links from TOC reorg

Fixed links to auth, backend, frontend, docker compose, helm & k8s

* docs: incorporating feedback

- Updates based on feedback
- Removing old manage peering admin guide so it doesn't show up in search

* docs: updates

* docs: pnpm format

running pnpm format
@melissahenderson melissahenderson mentioned this issue Dec 19, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@melissahenderson melissahenderson

Labels
user-doc-priority: medium User doc priority is medium user-docs
Projects
Documentation
Status: In Progress
Rafiki
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
2 participants
@melissahenderson @brad-dow