Skip to content
This repository has been archived by the owner on May 3, 2024. It is now read-only.

Improve links in developer's guide #308

Closed
johnbent opened this issue Dec 22, 2020 · 11 comments
Closed

Improve links in developer's guide #308

johnbent opened this issue Dec 22, 2020 · 11 comments
Assignees
Labels
documentation Improvements or additions to documentation needs-triage rose Swati Assigned to Swati

Comments

@johnbent
Copy link
Contributor

The developer's guide (https://github.com/Seagate/cortx-motr/blob/main/doc/motr-developer-guide.md) has three main sections:

  1. A simple Cortx Motr application (object)
  2. A simple Cortx Motr application (index)
  3. More examples, utilities, and applications

Right at the bottom of the intro (right before the first section A simple Cortx Motr application (object)), we should add:
These document contains the following sections:

  1. A simple Cortx Motr application (object)
  2. A simple Cortx Motr application (index)
  3. More examples, utilities, and applications
    And have these be (relevant) links to jump directly to those sections.

In the third section (More examples, utilities, and applications), there are a bunch of references to files (e.g. motr/st/utils/touch.c) which aren't links. These should be (relative) links to jump directly to the files.

FYI @huanghua78 and @andriytk and @VenkyOS

@VenkyOS
Copy link
Contributor

VenkyOS commented Dec 23, 2020

@johnbent - I will work on this accordingly.

@stale
Copy link

stale bot commented Dec 27, 2020

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @huanghua78 @mukundkanekar for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

@nkommuri
Copy link

nkommuri commented Nov 2, 2021

@VenkyOS , Please close the ticket if the requested work is done. Thanks.

@stale stale bot removed the needs-attention label Nov 2, 2021
@johnbent
Copy link
Contributor Author

johnbent commented Nov 2, 2021

@nkommuri , @VenkyOS is no longer at Seagate. These tickets can be reassigned to @swatid-seagate. FYI @novium258

@stale
Copy link

stale bot commented Nov 7, 2021

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @nkommuri @mehjoshi @huanghua78 for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

@stale stale bot added the needs-attention label Nov 7, 2021
@r-wambui r-wambui added documentation Improvements or additions to documentation rose Swati Assigned to Swati labels Nov 17, 2021
@stale
Copy link

stale bot commented Nov 21, 2021

This issue/pull request has been marked as needs attention as it has been left pending without new activity for 4 days. Tagging @nkommuri @mehjoshi @huanghua78 for appropriate assignment. Sorry for the delay & Thank you for contributing to CORTX. We will get back to you as soon as possible.

Copy link

Chandradhar Raval commented in Jira Server:

Assigning to [~936118] based on above comments from John B

Copy link

Pratik Patil commented in Jira Server:

Added links to sections in document

Copy link

Pratik Patil commented in Jira Server:

Improved developers guide by adding easy navigation links

Copy link

Pratik Patil commented in Jira Server:

Fixed

Copy link

Gaurav Chaudhari commented in Jira Server:

{panel:bgColor=#c1c7d0}h2. motr - main branch build pipeline SUCCESS
h3. Build Info:

h3. Image Location :

  • cortx-docker.colo.seagate.com/seagate/cortx-all:2.0.0-6025
    cortx-docker.colo.seagate.com/seagate/cortx-rgw:2.0.0-6025
    cortx-docker.colo.seagate.com/seagate/cortx-data:2.0.0-6025
    cortx-docker.colo.seagate.com/seagate/cortx-control:2.0.0-6025
    {panel}

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation needs-triage rose Swati Assigned to Swati
Projects
None yet
Development

No branches or pull requests

5 participants