Create wiki page to document test procedure for issues that modify issue templates

[roslynwythe]

Overview

We need to document the process for testing issues that modify issue templates.

Action Items

• Write a wiki page describing the process for testing issues that modify issue templates, based on Creating issues to Add Missing Labels to Issue Templates #4307 (comment)
• Do not include the last item "Copy these sections from the Issue into the PR" and the subitems
• As described in the Resources below, a draft wiki page will be created in a comment within this issue. When the draft wiki page is ready for review, move this issue into the Questions/In Review column.

Resources/Instructions

• We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Follow the instructions give in How to Contribute to the Wiki

[github-actions]

Hi @Ris345, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[Ris345]

Availability: 08/08/23
ETA: 09/08/23

[Ris345]

Testing issue templates

• Push your issue branch to your fork of the website repository, as described in Section 3.1.a of CONTRIBUTING doc, for example: git push --set-upstream origin test-update-labels-1234

• The response from the push command will include the URL for creating a pull request. Copy/Paste the URL for creating the Pull Request for later.

• Browse to your fork of the website repository and click Settings

  Screenshot of Repository Settings

  

• Change the default branch to the new issue branch

  Screenshot of Default Branch Setting

  

• Further down on the settings page under Features, check the Issues checkbox

  Screenshot of Issues Checkbox

  

• Browse to the Issues page, then click Labels

  Screenshot - creating labels in the test Repo

  

• Create labels corresponding to each label that was listed in the updated issue template. The color of the labels don't have to match those on the hackforla/website repository, but the text of the labels must match exactly.

• From the Issues page, click "New Issue" then locate the template updated by your issue, and click "Get Started" to open the issue template.

• Copy/Paste the URL of the updated issue template and save for later use.

• Verify the appearance of the issue template.

• Complete the PR process by visiting the URL saved from the push command.

• In the PR copy/paste this text immediately before the section "Screenshots of Proposed Changes Of The Website"

### For Reviewers
- Use this URL to check the updated issue template: [URL OF ISSUE TEMPLATE]

• Replace the text in the square brackets (as well as the square brackets) with the URL of the updated issue template

[LRenDO]

Hi @Ris345!

I am assuming this is ready for review even though the last check box was unchecked since it looks pretty close complete and there is no question in the comments.

This looks good overall! You copied the correct parts of the instructions and created a draft in a comment in this issue.

I only have a few changes to request.

• change the checkboxes to bullet points as this is more consistent with our wiki
• change the title to something like "Testing updated issue templates" to be more consistent with how our wiki is written
• add a link to the comment with the draft in it to the How to Contribute to the Wiki page

You can tag me in a separate comment once you make the changes.

Thanks for contributing to the wiki!

[Ris345]

@LRenDO Thanks for the feedback I made the suggested change, but not certain if the link I added is suppose to be that way?

[LRenDO]

Hi @Ris345!

Thanks for updating! The bullet points look great!

Let me clarify what you need to do for the title and link.

The title you had before was good. There is no need to mention the wiki in the title because the instructions you’re creating don’t modify the wiki. I just mentioned the wiki to explain why I requested the changed.

The change itself was only to adjust the title to something like “Testing updated issue templates"

For the link, please read the How to Contribute to the Wiki page, in particular the Creating a new wiki page section.

On that same page you will see links at the bottom. You need to add a link to the bottom of that list of links by editing the wiki page. The URL should go to the comment that contains your draft above.

You can get the URL for the comment by clicking the … in the top right corner of your comment with the draft.

For the link, there does not need to be a link added in the comment/draft you wrote. You can delete the link you added and change it back to the original "REPLACE THIS TEXT WITH URL OF THE ISSUE TEMPLATE ON THE TEST REPO"

Please let me know if you have any questions. Happy to clarify.

Edit: Apologies, writing this on my phone and it got a little funky. Tried to clean it up.

[Ris345]

@LRenDO Thanks for the comments still confused about what I should do with the link and how to create a draft the three dots only show copy link or reference in new issue.

[LRenDO]

Hi @Ris345! Title update looks great! Below is a step by step instruction for adding the link to the How to Contribute to the Wiki page. If you're still having trouble, let me know and we can connect on Slack. I'm available on and off today.

• Copy the URL of the comment that contains your draft. You can do this by:

  • Clicking the . . . button in the upper right hand corner of the comment that contains the draft as pictured below
  • Clicking Copy Link on the drop down menu as pictured below
    

• Go to the How to Contribute to the Wiki page

• Click the edit button pictured below
  

• At the very bottom of the page add your link in the markdown link format that uses brackets and parentheses [REPLACE THIS TEXT WITH TITLE OF YOUR DRAFT](REPLACE THIS TEXT BY PASTING COPIED URL HERE).

• Click Save

• Confirm that it has been added at the end and it is displaying and linking properly

It should be all set after that!

[Ris345]

@LRenDO Thank you for these extremely clear instructions, I think I completed all the necessary steps. Let me know if I am missing anything.

[LRenDO]

@Ris345 Awesome! Glad we got there! Looks great. The draft is now correctly linked on the How to contribute to the Wiki page. Thanks for making the changes!