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.

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

[Fink] Fink editor contributers ask for guide #1750

Closed
NilsJacobsen opened this issue Nov 27, 2023 · 6 comments
Closed

[Fink] Fink editor contributers ask for guide #1750

NilsJacobsen opened this issue Nov 27, 2023 · 6 comments
Assignees
Labels
scope: inlang/fink-editor Related to source-code/website/editor. type: documentation Improvements or additions to documentation

Comments

@NilsJacobsen
Copy link
Contributor

Problem

People asking for a contribution guide

"If aggregating all inputs on documentation in here I have my point:

  • how to use guide for Inlang editor for people who use it to contribute to OSS projects via Inlang
  • basic simple usage - how to make references, what statuses mean, etc. ('Missing translation' pop-up textation was confusing to me as a newcomer)" from @stmr, Improve inlang's SDK documentation #1667

@inlang/editor @NiklasBuchfink do you think that makes sense?

@maige-app maige-app bot added scope: inlang/fink-editor Related to source-code/website/editor. type: documentation Improvements or additions to documentation labels Nov 27, 2023
@NiklasBuchfink
Copy link
Member

I guess there are more discussion points:

  1. Guide:
    It makes sense to have a guide in a form like this. Projects can refer to it and it is a good starting point for anyone who only uses the editor to contribute to a project.
  2. How to make references:
    Could you clarify? We got the reference language or source language, which is usually the English translation and is provided by the maintainers. If the reference language contains variables or variable references, these are highlighted and can be selected via a floating menu when clicking into a text field of another language.
    Currently there is no way to create a new variableReference within the editor. Do you think this is needed for the reference language? Or is it just the selection of a variableReference and we have a bug that this floating menu is empty or absent?
  3. What statuses mean:
    Please correct me, if I'm wrong. It's not that the wording of "missing translation", which is quite descriptive with an empty text box next to it. It's about better status descriptions within the pop-up text, right? We need to update the description so that it is easy to understand. This could also affect other apps that display the description.

@NiklasBuchfink
Copy link
Member

Update on 2. :
We have a bug that the floating menu doesn't show up occasionally. This makes it confusing for the user. I got it on the list for this week.

@stmr
Copy link

stmr commented Nov 27, 2023

  1. That link is exactly what I was looking for when first trying to kickstart with Inlang!
  2. By references I meant
    Screenshot 2023-11-27 at 12-22-38 stmr_AppFlowy and there is bug for them not showing occasionally that's why the confusion but the linked guide from 1. would be informative enough to deduct it is broken and I am not doing anything wrong or missing something
  3. It is explanatory when working properly but I am getting both green tick and "missing translation" which confused me. I was trying to find other occurrences of the phrase to see if there are more missing translations (also another bug I've created)

@NiklasBuchfink
Copy link
Member

@NilsJacobsen Can you create the contributor guide this way? I focus on fixing the bugs :)

@NiklasBuchfink
Copy link
Member

We have a guide now: https://inlang.com/g/6ddyhpoi/guide-nilsjacobsen-contributeTranslationsWithFink
Thank you @NilsJacobsen for writing this 👏

@stmr Let us know if this would have helped you in your first steps with the Fink editor :)

I'll wait until #1762 is merged and will add a link to the Fink product page.

@stmr
Copy link

stmr commented Nov 30, 2023

What a blissful guide! Thanks! @NiklasBuchfink @NilsJacobsen

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: inlang/fink-editor Related to source-code/website/editor. type: documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants