Skip to content
This repository has been archived by the owner on Aug 2, 2021. It is now read-only.

[FEATURE] Marker Editing through GitHub integration #355

Open
EliteMasterEric opened this issue Apr 19, 2021 · 1 comment
Open

[FEATURE] Marker Editing through GitHub integration #355

EliteMasterEric opened this issue Apr 19, 2021 · 1 comment
Labels
enhancement A new feature for the site.

Comments

@EliteMasterEric
Copy link
Owner

The intended user experience for this feature is as follows:

  • Have the user head to the Sync tab and authenticate GenshinMap for their account.
  • Once authenticated, you can click a button on a marker popup to pull up a form. On this form you can choose an option:
    • Update Text: Provides the ability to add data for a new translation or edit existing text.
    • Add Image: Provides the ability to add an image.
    • Move Marker to Another Feature: Provides the ability to select another feature to move the marker to. This can be a different marker in the same region (example use case: Adding a chest from Common to Exquisite) or to a different region (example: moving a chest from Mondstadt to Dragonspine).
    • Relocate or Remove: Provides a simple text field where the user can provide more information.
  • Upon clicking submit, the user will NOT be redirected to GitHub like the current implementation of the editor. Instead, the following steps will happen:
    • For Relocate or Remove, the GitHub API will be used to create a new issue in the user's name describing the problem along with referencing the associated marker.
    • For all the other modes, the GitHub API will create a new fork of the repository on the user's account. Then, it will create a new branch on that repository. Then, it will perform the requested change directly to the data files on that fork such that a new commit is created. Then, it will submit a pull request to the original repository for that change to be implemented.
@EliteMasterEric EliteMasterEric added the enhancement A new feature for the site. label Apr 19, 2021
@EliteMasterEric EliteMasterEric added this to Far Back Burner in Bugs and Features via automation Apr 19, 2021
@EliteMasterEric EliteMasterEric moved this from Far Back Burner to Back Burner in Bugs and Features Apr 19, 2021
@EliteMasterEric
Copy link
Owner Author

Add https://www.npmjs.com/package/@octokit/rest
Add a feature for the user to authenticate with GitHub via OAuth.
Create an issue: https://octokit.github.io/rest.js/v18#issues-create

@EliteMasterEric EliteMasterEric moved this from Back Burner to Far Back Burner in Bugs and Features Jun 13, 2021
@EliteMasterEric EliteMasterEric moved this from Far Back Burner to Back Burner in Bugs and Features Jun 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement A new feature for the site.
Projects
Development

No branches or pull requests

1 participant