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

Change git clone commands for wiki editing to not use https #36151

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

FredrIQ
Copy link

@FredrIQ FredrIQ commented Feb 3, 2025

Since you cannot actually push changes to your wiki if you use https, the clone command should not instruct you to use https when cloning.

Why:

Closes: #36150

What's being changed (if available, include any code snippets, screenshots, or gifs):

I changed https://github.com/github/docs/blob/main/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md to suggest cloning with SSH instead of HTTPS

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the preview environment.

Since you cannot actually push changes to your wiki if you use https, the clone
command should not instruct you to use https when cloning.
Copy link

welcome bot commented Feb 3, 2025

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 3, 2025
Copy link
Contributor

github-actions bot commented Feb 3, 2025

👓 Previews for changed content

This comment is 🤖 automatically generated and will be overwritten every time changes are committed to this branch.

The table contains an overview of files in the content directory that have been changed in this pull request. It's provided to make it easy to review your changes on the review server. Please note that changes to the data directory will not show up in this table.


Content directory changes

You may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.

Source Preview Production What Changed
communities/documenting-your-project-with-wikis/editing-wiki-content.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server
This table is posted from the Content Changes Table Comment workflow.

@@ -45,7 +45,7 @@ Wikis can display PNG, JPEG, and GIF images.

You can link to an image in a repository on {% data variables.product.github %} by copying the URL in your browser and using that as the path to the image. For example, embedding an image in your wiki using Markdown might look like this:

[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]
[[git@github.com:USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @FredrIQ, and thanks for your submission

Did you suggest editing the right page? It looks like you may have meant to suggest edits to https://docs.github.com/en/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages?

Additionally, I've just tested and I'm able to push changes to a wiki using HTTPS, so I'm not sure the docs are incorrect here. Is it possible something else has happened with your configuration? If so, this wouldn't be the best place to get support, but I'm happy to leave this open for now in case there is in fact a problem with the docs I'm not seeing

@subatoi subatoi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review more-information-needed More information is needed to complete review and removed triage Do not begin working on this issue until triaged by the team labels Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Editing wiki pages should not suggest using https for git clone
2 participants