search

prifina / prifina-app-starter

Build personal data apps on the Prifina framework using this app starter repo and the related utilities.
http://docs.prifina.com
12 stars 15 forks source link

Disambiguate the "How to Start?" section for first-time contributors. #17

Closed tashachin closed 3 years ago

tashachin commented 3 years ago

Current Copy

How to Start?

When you have decided the application you want to build and have the data sources identified, a simple way to start building is by simply forking the relevant GitHub library and start building your own app.

You can also use these open source components from our Blend Design System library in our Storybook, and other useful assets from our GitHub.

You do not need to use these assets, but they can help get you started.

Arayna525 commented 3 years ago

@tashachin instead of using the title "How to Start" how about using "Getting Started" instead?

Arayna525 commented 3 years ago

@tashachin Purpose:

The purpose of this section is to provide steps on how to build your own app though prifina on GitHub.

Arayna525 commented 3 years ago

@tashachin not sure where to find it but I would suggest adding a background section that explains prifina before the getting started section.

tashachin commented 3 years ago

@Arayna525 In response to your comments:

  1. We have a section here called Getting Started on the README.md file.

Context: We could add the content from this "How to Start" section underneath Getting Started, but:

  1. I jumped between this issue and #22 when I realized the actual purpose behind "How to Start"'s content

does not clearly convey that this section in the greater scope of the entire README is about generating ideas for third-party devs (quote and emphasis mine)

So we need a more concise and accurate section title than "How to Start" or "Getting Started".

  1. Currently, the About Prifina information lives on our live website, and that copy does not correlate to this repository.

In summary: Our README is for both third-party (the general public) developers and non-developers to use as a gauge for whether or not they'd like to collaborate with us.

Next steps: I'd like to know if:

Arayna525 commented 3 years ago

Ok I will check out the readme file. Do I post changes as comments?

tashachin commented 3 years ago

Do I post changes as comments?

In other words, let me know what workflow makes the most sense for you and we can integrate that!

Arayna525 commented 3 years ago

Workflow A works best for me.

On Mon, May 3, 2021, 3:32 PM Ren C. @.***> wrote:

Do I post changes as comments?

  • Workflow A: Copy the entire document, post it in a Google Doc, and comment in-line with any questions you have and make suggestions using GDocs' suggestion feature.
  • Workflow B: Make changes in a text editor with syntax highlighting (like Atom or Sublime) and push the changes to GitHub.
  • Workflow C: Something I haven't considered that is way simpler.

In other words, let me know what workflow makes the most sense for you and we can integrate that!

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/prifina/prifina-app-starter/issues/17#issuecomment-831482750, or unsubscribe https://github.com/notifications/unsubscribe-auth/AP42C4LSGHJQDNOBBZ33UELTL3255ANCNFSM4YRVDPQQ .

tashachin commented 3 years ago

@Arayna525 Perfect, I'll assign you to this issue, then.

Arayna525 commented 3 years ago

Thanks. Do I post my changes to the document here or invite you to the working doc when I create it in Google?

tashachin commented 3 years ago

Could you invite @., @. (me), and @.***?

Thank you, Arayna!

On Tue, May 4, 2021 at 9:18 AM Arayna Hamilton @.***> wrote:

Thanks. Do I post my changes to the document here or invite you to the working doc when I create it in Google?

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/prifina/prifina-app-starter/issues/17#issuecomment-832068742, or unsubscribe https://github.com/notifications/unsubscribe-auth/AGTOFF5GQIY5EC2AKN36QRTTMAM6ZANCNFSM4YRVDPQQ .

-- Tasha Chin What'sApp: 510 604 0755 Timezone: GMT-8 ( Pacific / Los Angeles ) Socials: https://linktr.ee/blaiddyd

Arayna525 commented 3 years ago

ok once I create the doc, I will invite you.

Thanks,

Arayna

On Wed, May 5, 2021 at 1:19 PM Ren C. @.***> wrote:

Could you invite @., @. (me), and @.***?

Thank you, Arayna!

On Tue, May 4, 2021 at 9:18 AM Arayna Hamilton @.***> wrote:

Thanks. Do I post my changes to the document here or invite you to the working doc when I create it in Google?

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub < https://github.com/prifina/prifina-app-starter/issues/17#issuecomment-832068742 , or unsubscribe < https://github.com/notifications/unsubscribe-auth/AGTOFF5GQIY5EC2AKN36QRTTMAM6ZANCNFSM4YRVDPQQ

.

-- Tasha Chin What'sApp: 510 604 0755 Timezone: GMT-8 ( Pacific / Los Angeles ) Socials: https://linktr.ee/blaiddyd

— You are receiving this because you were assigned. Reply to this email directly, view it on GitHub https://github.com/prifina/prifina-app-starter/issues/17#issuecomment-832868602, or unsubscribe https://github.com/notifications/unsubscribe-auth/AP42C4LKEZOQE3JNQTRTWKTTMF4ZHANCNFSM4YRVDPQQ .

Arayna525 commented 3 years ago

Hello,

My updates are going slow because I am taking a web design course and I have a week to go but I promise I will get you the tweaks 😊

Arayna

On Mon, May 3, 2021, 12:20 PM Ren C. @.***> wrote:

@Arayna525 https://github.com/Arayna525 In response to your comments:

  1. We have a section here https://github.com/prifina/prifina-app-starter#getting-started called Getting Started on the README.md file.

Context: We could add the content from this "How to Start" section underneath Getting Started, but:

  1. I jumped between this issue and #22 https://github.com/prifina/prifina-app-starter/issues/22 when I realized the actual purpose behind "How to Start"'s content

does not clearly convey that this section is about generating ideas for third-party devs

So we need a more concise and accurate section title than "How to Start" or "Getting Started".

  1. Currently, the About Prifina information lives on our (live website)[http://docs.prifina.com/#the-tldr], and that copy does not correlate to this repository.

In summary: Our README is for both third-party (the general public) developers and non-developers to use as a gauge for whether or not they'd like to collaborate with us.

Next steps: I'd like to know if:

  • You've further questions
  • You're ready for more task items

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/prifina/prifina-app-starter/issues/17#issuecomment-831372365, or unsubscribe https://github.com/notifications/unsubscribe-auth/AP42C4JCIOUNWNLV4KQVGOTTL3ENBANCNFSM4YRVDPQQ .

tashachin commented 3 years ago

@Arayna525 Thanks for the updates. I've added some suggestions and corrected some areas in terms of technicalities to remind us both of how the starter-app works.

On a second read through, I think it'd be more efficient if we renamed the How to Start section to Building An Application for Prifina and reworked the copy like so:

Building An Application for Prifina

Once you have identified which data sources you want to use to build an app, the simplest way to begin is to fork this repository and extend the starter template code.

You can also use the components from our Blend Design System library found within our Storybook, as well as other useful assets hosted on our GitHub. // Note to self: Figure out what assets this sentence refers to.

While it isn't necessary to use our assets, they can be a good starting point.

tashachin commented 3 years ago

Developer Information

The Prifina app provided on GitHub is a container application. This starter repository helps third-party developers create ideas and apps within the Prifina platform. Developers can download Prifina's pre-built libraries, assets, and components which can assist them in designing their application. The following information provides guidance on how to build a Prifina application and submit it to the Prifina Team for review.

The Prifina Team is transparent at every step of the review process and will address any questions or concerns developers have regarding their submission(s). For questions and to check the status of a submission, contact Prifina at: info@prifina.com.

Building Your Application

An easy way to start building your application is to fork the relevant Prifina repository. You can also use open-source components and assets located in our Blend Design System library or Storybook that are hosted on our GitHub. You do not need to use these resources, but they can get you started.

Note: “The Prifina Starter Kit” is built on React. There is no need to run the create-react-app command.

@Arayna525 I'm looking over this copy with fresh eyes and it reads as very technical and matter-of-factly. It's concise and designed for people coming from a broader non-technical audience in mind.

@mmlampinen Ready for your input as well, Markus. I'd like some help in deciding whether you prefer this technical tone on the GitHub README because it's in line with Prifina's professional voice.

Arayna525 commented 3 years ago

@tashachin thank you for the feedback. Let me know if this works well with your scope and intent and I am happy to work with you on other outstanding issues you have with your documentation.

Also, after re-reading this copy, I noticed that I missed putting a space between the words "storybook" and "that" in the Building Your Application section😊.

mmlampinen commented 3 years ago

Maybe for the contact email we can use "info@prifina.com"