Skip to content
This repository was archived by the owner on Apr 12, 2022. It is now read-only.

Commit 3c33d34

Browse files
Documentation improvements.
1 parent 4a2ed1e commit 3c33d34

File tree

3 files changed

+14
-10
lines changed

3 files changed

+14
-10
lines changed

docs/installing.markdown

+8-4
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,15 @@ order: 1
1414

1515
On first launch, `Bittray` will ask for two things:
1616

17-
1. The URL of your Bitbucket Enterprise server, and
18-
1. The username you use to log in to Bitbucket
17+
1. The username you use to log in to Bitbucket, and
18+
1. The URL of your Bitbucket server
1919

20-
These two settings are stored in the [Windows Credential Manager](https://support.microsoft.com/en-ca/help/4026814/windows-accessing-credential-manager)
21-
as a _Windows Credential_ under the key `bittray:conf`.
20+
These two settings are stored in the [Windows Credential Manager](https://support.microsoft.com/en-ca/help/4026814/windows-accessing-credential-manager)
21+
as a _Windows Credential_ under the key `bittray:conf`.
22+
23+
1. You will then be asked for your Bitbucket password.
24+
25+
It will be not stored and is only valid until you quit Bittray. See [Security]({{ site.baseurl }}/security) for more details.
2226

2327
### Note
2428
The URL must take _exactly_ the format `http://example.com:7990`, with a port (if not `80`) and no trailing slash.

docs/security.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ You will be asked to provide the password you use to log in to Bitbucket _every
1515

1616
The WCM [is not a secure password store](https://github.com/michaelsanford/bittray/issues/14) by default.
1717

18-
In order to securely store the password in the WCM in a retrievable form, I would have needed to encrypt it using
18+
In order to securely store the password in the WCM (or registry, or anywhere) in a retrievable form, it would need to be encrypted using
1919
a passphrase provided by the user.
2020

2121
The user would need to enter that decryption passphrase every time `Bittray` launched to decrypt the stored Bitbucket
2222
credentials.
2323

24-
It saves no clicks to store it.
24+
It saves no effort to store it.
2525

2626
Storing it is arguably actively harmful.
2727

docs/using.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ order: 2
77

88
# What Counts as "Pending"
99

10-
A Pull Request will appear in the pending queue and provoke the alarm icon if
10+
A Pull Request will appear in the Pending queue and provoke the alarm icon if
1111

12-
1. You are involved as a Reviewer
12+
1. You are involved as a Reviewer, and
1313
1. You have not clicked `Approved` or `Needs Work`
1414

15-
Clicking `Needs Work` signifies to the developer that the PR requires attention, and it will remove it from your queue.
15+
Clicking `Needs Work` says to the developer that the PR requires attention and will remove it from your queue because you've "done something about it".
1616

17-
The next time the developer pushes, the `Needs Work` flag is automatically cleared and the request will fall back into Pending.
17+
When the developer pushes a new changeset, the `Needs Work` flag is automatically cleared and the request will fall back into Pending.
1818

1919
# Icon States
2020

0 commit comments

Comments
 (0)