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

Added guidance on file to choose to download #20474

Merged
merged 8 commits into from
Jul 29, 2022
Merged

Conversation

apxltd
Copy link
Contributor

@apxltd apxltd commented Jul 25, 2022

To help clarify which file to download, I added some guidance on what the different files mean.

@a1012112796 a1012112796 added the type/docs This PR mainly updates/creates documentation label Jul 25, 2022
@GiteaBot GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Jul 25, 2022
@apxltd
Copy link
Contributor Author

apxltd commented Jul 26, 2022

@a1012112796 I think I updated the file now :)

@apxltd
Copy link
Contributor Author

apxltd commented Jul 26, 2022

@zeripath I'm just a Windows dummy who couldn't figure out what file to download and had no idea what gogit is. I just wanted to try to make it easier for other dummies to figure out how to install Gitea 😉

Someone should decide for dummies like me if we should start with gogit-windows or windows, and tell us when to try the other. I tried to explain, but still I don't get it. I suppose could edit the documentation to encourage the reader to "flip a coin" and try the other one if it doesn't work... but I figure the smart people like you could say something better 😆

If you can tell me what to write, I can write it - but it might be faster for you to just edit what I wrote to be technically accurate.

@apxltd
Copy link
Contributor Author

apxltd commented Jul 26, 2022

@zeripath ooh as for 32-bit and 64-bit.... there really isn't 32-bit Windows anymore, I mean.. not since Windows Server 2008 (which is out of support). Is the same true on Linux? Would you be OK if we clarify, for the younguns who've never seen a 32-bit operating system, that they probably just want 64-bit... but they can use the 32-bit ones if they have an old OS?

@zeripath
Copy link
Contributor

@zeripath I'm just a Windows dummy who couldn't figure out what file to download and had no idea what gogit is. I just wanted to try to make it easier for other dummies to figure out how to install Gitea wink

Someone should decide for dummies like me if we should start with gogit-windows or windows, and tell us when to try the other. I tried to explain, but still I don't get it. I suppose could edit the documentation to encourage the reader to "flip a coin" and try the other one if it doesn't work... but I figure the smart people like you could say something better laughing

If you can tell me what to write, I can write it - but it might be faster for you to just edit what I wrote to be technically accurate.

I don't use windows and so I can't tell you which to try.

We provide the go-git builds because some windows users find that using the git binary calls makes things too slow - however, these users are unable or unwilling to debug further or provide us with further explanations other than Gitea is slow.

I think the point is to say - try both and see which is quicker for you. Gogit appears quicker for at least some people but despite asking people to tell us whether that is always the case no-one has told us. If it was obvious which was better we'd provide only one build - but we don't have the information - thus there's a reason why both builds are provided.

@apxltd
Copy link
Contributor Author

apxltd commented Jul 27, 2022

@zeripath thanks for the guidance

I tried to articulate why gogit exists, and when to use it. This will also help you gather data.

I researched a bit more about 32-bit, arm5/6, and those seem really rare these days. I couldn't even see where to download 32-bit ubuntu anymore.

"Apple Silicone" is apparently what they call it, and it looks like it's a crapshoot now as to what users have.

@wxiaoguang
Copy link
Contributor

Now there is a markdown linter 😁

So there are some lint errors during CI to be fixed.

https://drone.gitea.io/go-gitea/gitea/58210/1/4

npx markdownlint docs *.md

docs/content/doc/installation/from-binary.en-us.md:27:153 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 1]

docs/content/doc/installation/from-binary.en-us.md:29 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "### Choosing the right file"]

docs/content/doc/installation/from-binary.en-us.md:31:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 1]

docs/content/doc/installation/from-binary.en-us.md:41 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```sh"]

docs/content/doc/installation/from-binary.en-us.md:48 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

make: *** [Makefile:316: lint-frontend] Error 1

@apxltd
Copy link
Contributor Author

apxltd commented Jul 28, 2022

@wxiaoguang I feel I'm allllmost there, hopefully this fixes the problem of the markdown :)

Copy link
Contributor

@wxiaoguang wxiaoguang left a comment

Choose a reason for hiding this comment

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

The improved content looks good to me.

ps: I am not a native speaker for English, not sure whether the syntax ..., but there are other platforms available (the but) is a common one in English.

@GiteaBot GiteaBot added lgtm/need 1 This PR needs approval from one additional maintainer to be merged. and removed lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. labels Jul 28, 2022
@Gusted Gusted added the skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. label Jul 28, 2022
@GiteaBot GiteaBot added lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. and removed lgtm/need 1 This PR needs approval from one additional maintainer to be merged. labels Jul 28, 2022
@lunny
Copy link
Member

lunny commented Jul 29, 2022

make L-G-T-M work

@lunny lunny merged commit c5bdea9 into go-gitea:main Jul 29, 2022
zjjhot added a commit to zjjhot/gitea that referenced this pull request Aug 1, 2022
* giteaofficial/main: (29 commits)
  [skip ci] Updated translations via Crowdin
  Support localized README (go-gitea#20508)
  Clean up and fix clone button script (go-gitea#20415)
  Add disable download source configuration (go-gitea#20548)
  Fix default merge style (go-gitea#20564)
  Update login methods in package docs (go-gitea#20561)
  Add missing Tabs on organisation/package view (Frontport go-gitea#20539) (go-gitea#20540)
  [skip ci] Updated licenses and gitignores
  Add setting `SQLITE_JOURNAL_MODE` to enable WAL (go-gitea#20535)
  Rework file highlight rendering and fix yaml copy-paste (go-gitea#19967)
  Add new API endpoints for push mirrors management (go-gitea#19841)
  WebAuthn CredentialID field needs to be increased in size (go-gitea#20530)
  Add latest commit's SHA to content response (go-gitea#20398)
  Improve token and secret key generation docs (go-gitea#20387)
  [skip ci] Updated translations via Crowdin
  Rework raw file http header logic (go-gitea#20484)
  Update lunny/levelqueue to prevent NPE when reads are performed after close (go-gitea#20534)
  Added guidance on file to choose to download (go-gitea#20474)
  [skip ci] Updated translations via Crowdin
  Ensure that all unmerged files are merged when conflict checking (go-gitea#20528)
  ...
vsysoev pushed a commit to IntegraSDL/gitea that referenced this pull request Aug 10, 2022
* Added guidance on file to choose to download

* Update from-binary.en-us.md

* Update from-binary.en-us.md

* Update from-binary.en-us.md

* Update docs/content/doc/installation/from-binary.en-us.md

* Update docs/content/doc/installation/from-binary.en-us.md

Co-authored-by: wxiaoguang <[email protected]>
Co-authored-by: 6543 <[email protected]>
@go-gitea go-gitea locked and limited conversation to collaborators May 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lgtm/done This PR has enough approvals to get merged. There are no important open reservations anymore. skip-changelog This PR is irrelevant for the (next) changelog, for example bug fixes for unreleased features. type/docs This PR mainly updates/creates documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants