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

Update reusable variables with new route #2919

Open
megbird opened this issue Jan 15, 2021 · 10 comments · May be fixed by #5538
Open

Update reusable variables with new route #2919

megbird opened this issue Jan 15, 2021 · 10 comments · May be fixed by #5538

Comments

@megbird
Copy link
Member

@megbird megbird commented Jan 15, 2021

We currently use the following three steps to point a user to org settings:

{{ site.data.reusables.profile.access_profile }}

  • file path = data/resuables/profile
    {{ site.data.reusables.profile.access_org }}
  • file path = data/resuables/profile
    {{ site.data.reusables.organizations.org_settings }}
  • file path = data/resuables/org_settings

However, there is a slightly cleaner route of:

  1. In the top right corner of GitHub, click your profile photo, then click "Your Organizations".
  2. Click settings next to the org in the list.

We should update the reusables to use the simpler route.

Content strategy and implementation

Item Core DSP Ecosystem/API
Unified content strategy plan

Please link any in-flight PRs to this issue.

@github-actions github-actions bot added this to Triage in Docs team reviews Jan 15, 2021
@janiceilene janiceilene moved this from Triage to Available issues in Docs team reviews Jan 15, 2021
@lumenCodes
Copy link

@lumenCodes lumenCodes commented Feb 5, 2021

Hi, I would like to take up this issue, but I am confused on the file that will be affected (where the change will be made).

@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Feb 5, 2021

👋 @lumenCodes You're welcome to take this on! Two of the files (access_profile and access_org) are located in the reusables directory, in the profiles folder https://github.com/github/docs/tree/main/data/reusables/profile. The third one (org_settings) is in the organizations folder https://github.com/github/docs/blob/main/data/reusables/organizations/org_settings.md.

@megbird Are you looking for each of the three reusables to be updated to follow the two steps you outlined?

  1. In the top right corner of GitHub, click your profile photo, then click "Your Organizations".
  2. Click settings next to the org in the list.
@lumenCodes
Copy link

@lumenCodes lumenCodes commented Feb 10, 2021

Thank you so much!

@lumenCodes lumenCodes mentioned this issue Feb 22, 2021
3 of 3 tasks complete
@megbird
Copy link
Member Author

@megbird megbird commented Feb 23, 2021

So sorry I haven't given any guidance for this!

We use reusable files that we can use as variables all over the site. This issue suggests that we update three reusable and condense them down to two.

For this PR, let's make the following updates:

  • Update file data/resuables/profile/access_org to say:
  1. In the top right corner of GitHub, click your profile photo, then click "Your Organizations".
  • Update data/reusables/profile/org_settings.md to say:
  1. Click Settings next to the organization.
  • Find instances where this occurs in the docs and replace
{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}

with this

{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}

☝️ make sure to only replace instances where all three reusable are used in this sequence, so that the procedure is still in order 😄

@lumenCodes I know you've already started a PR, ping me in if you have any questions! 💛

@StarTrooper08
Copy link
Contributor

@StarTrooper08 StarTrooper08 commented Mar 12, 2021

May I try to resolve this issue #2919 @megbird

StarTrooper08 added a commit to StarTrooper08/docs that referenced this issue Mar 12, 2021
changes made for issue no github#2919
@StarTrooper08 StarTrooper08 mentioned this issue Mar 12, 2021
3 of 3 tasks complete
StarTrooper08 added a commit to StarTrooper08/docs that referenced this issue Mar 12, 2021
changes made for issue no github#2919
@StarTrooper08 StarTrooper08 mentioned this issue Mar 12, 2021
3 of 3 tasks complete
@StarTrooper08
Copy link
Contributor

@StarTrooper08 StarTrooper08 commented Mar 12, 2021

I m bit of confused for changes to be made for replacing instance .Can I get help for this??

@hamedtayeban

This comment was marked as spam.

@janiceilene
Copy link
Collaborator

@janiceilene janiceilene commented Mar 16, 2021

@StarTrooper08 I see your two PRs and they look 👍 The last piece of this issue is the docs to find all the places where the three reusables are used

{% data reusables.profile.access_profile %}
{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}

and replace them with

{% data reusables.profile.access_org %}
{% data reusables.organizations.org_settings %}

as described in #2919 (comment). Searching in the repo on github.com will give you a bunch of partial results, so you'll want to use your editor to search instead.

@StarTrooper08
Copy link
Contributor

@StarTrooper08 StarTrooper08 commented Mar 17, 2021

ok I will do it 👍

@StarTrooper08 StarTrooper08 linked a pull request that will close this issue Apr 19, 2021
0 of 3 tasks complete
@StarTrooper08
Copy link
Contributor

@StarTrooper08 StarTrooper08 commented Apr 19, 2021

@janiceilene I have made a PR for #2919 issue . Please have a review.
I have reviewed from my side but still it is major fixture so its better to review it ones more.
Thank you that was fun and exciting work.
And sorry for the delay I was having my college work.

@shati-patel shati-patel linked a pull request that will close this issue Apr 21, 2021
0 of 3 tasks complete
@shati-patel shati-patel removed a link to a pull request Apr 21, 2021
0 of 3 tasks complete
@shati-patel shati-patel linked a pull request that will close this issue Apr 21, 2021
0 of 3 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked pull requests

Successfully merging a pull request may close this issue.

12 participants
@megbird @janiceilene @hamedtayeban @lumenCodes @StarTrooper08 and others