Skip to content

Commit

Permalink
Rebrand to Phrase Strings (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
strzibny authored Sep 27, 2022
1 parent 4e449ea commit 79c5638
Show file tree
Hide file tree
Showing 54 changed files with 172 additions and 150 deletions.
6 changes: 3 additions & 3 deletions clients/cli/build/innosetup/phrase-cli-386.iss.template
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
; Do not use the same AppId value in installers for other applications.
; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
AppId={{DC598D8E-8A9B-4CAD-AFD8-0324FDF4E0F1}
AppName=Phrase CLI
AppName=Phrase Strings CLI
AppVersion=VERSION
AppPublisher=Phrase GmbH
AppPublisherURL=https://phrase.com/cli
Expand Down Expand Up @@ -35,5 +35,5 @@ Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environmen
AlwaysRestart = yes

[Icons]
Name: "{group}\Phrase CLI"; Filename: "{app}"
Name: "{group}\{cm:UninstallProgram,Phrase CLI}"; Filename: "{uninstallexe}"
Name: "{group}\Phrase Strings CLI"; Filename: "{app}"
Name: "{group}\{cm:UninstallProgram,Phrase Strings CLI}"; Filename: "{uninstallexe}"
6 changes: 3 additions & 3 deletions clients/cli/build/innosetup/phrase-cli.iss.template
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
; Do not use the same AppId value in installers for other applications.
; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
AppId={{DC598D8E-8A9B-4CAD-AFD8-0324FDF4E0F1}
AppName=Phrase CLI
AppName=Phrase Strings CLI
AppVersion=VERSION
AppPublisher=Phrase GmbH
AppPublisherURL=https://phrase.com/cli
Expand Down Expand Up @@ -36,5 +36,5 @@ Root: HKLM; Subkey: "SYSTEM\CurrentControlSet\Control\Session Manager\Environmen
AlwaysRestart = yes

[Icons]
Name: "{group}\Phrase CLI"; Filename: "{app}"
Name: "{group}\{cm:UninstallProgram,Phrase CLI}"; Filename: "{uninstallexe}"
Name: "{group}\Phrase Strings CLI"; Filename: "{app}"
Name: "{group}\{cm:UninstallProgram,Phrase Strings CLI}"; Filename: "{uninstallexe}"
20 changes: 10 additions & 10 deletions clients/cli/build/innosetup/postinstall.rtf
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
Phrase Client
Phrase Strings Client
================

The Phrase Client is available for all major platforms and lets you
The Phrase Strings Client is available for all major platforms and lets you
access all API endpoints as well as easily sync your locale files
between your source code and Phrase.

Check out our documentation for more
information <https://help.phrase.com/help/phrase-in-your-terminal>.
information <https://support.phrase.com/hc/en-us/articles/5808300599068>.

Quick Start
-----------

This quick start will guide you through the basic steps to get up and
running with the Phrase Client.
running with the Phrase Strings Client.

1. Install
^^^^^^^^^^

Download and install <https://phrase.com/cli> the client for your
platform. See our detailed installation
guide <https://help.phrase.com/help/installation-1>
guide <https://support.phrase.com/hc/en-us/articles/5784093863964>
for more information.

2. Init
Expand All @@ -37,7 +37,7 @@ locale file format, source files and more.
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Use the push command to upload your locale files from your defined
sources <https://help.phrase.com/help/configuration>:
sources <https://support.phrase.com/hc/en-us/sections/5784132012828>:


$ phrase push
Expand All @@ -46,7 +46,7 @@ sources <https://help.phrase.com/help/configuration>:
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Use the pull command to download the most recent locale files back
into your project according to your targets <https://help.phrase.com/help/configuration>:
into your project according to your targets <https://support.phrase.com/hc/en-us/sections/5784132012828>:


$ phrase pull
Expand All @@ -65,8 +65,8 @@ flag:

$ phrase locales list --help

See our detailed guides <https://help.phrase.com/help/phrase-in-your-terminal>
for in-depth instructions on how to use the Phrase Client.
See our detailed guides <https://support.phrase.com/hc/en-us/articles/5808300599068>
for in-depth instructions on how to use the Phrase Strings Client.

Contributing
------------
Expand All @@ -79,7 +79,7 @@ report bugs.
Further reading
---------------

- Phrase Client Download Page <https://phrase.com/cli>
- Phrase Strings Client Download Page <https://phrase.com/cli>

Licenses
--------
Expand Down
6 changes: 3 additions & 3 deletions clients/cli/cmd/info.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ func initInfo() {

func GetInfo() string {
info := []string{
fmt.Sprintf("Phrase client version: %s", PHRASE_CLIENT_VERSION),
fmt.Sprintf("Phrase client revision: %s", REVISION),
fmt.Sprintf("Phrase library revision: %s", LIBRARY_REVISION),
fmt.Sprintf("Phrase Strings client version: %s", PHRASE_CLIENT_VERSION),
fmt.Sprintf("Phrase Strings client revision: %s", REVISION),
fmt.Sprintf("Phrase Strings library revision: %s", LIBRARY_REVISION),
fmt.Sprintf("Last change at: %s", LAST_CHANGE),
fmt.Sprintf("Go version: %s", runtime.Version()),
}
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func init() {
func initInit() {
var pullCmd = &cobra.Command{
Use: "init",
Short: "Configure your Phrase client",
Short: "Configure your Phrase Strings client",
Long: "",
Run: func(cmd *cobra.Command, args []string) {
cmdInit := commands.InitCommand{
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/internal/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ func (cmd *InitCommand) selectFormat() error {
fmt.Printf("%2d: %s - %s, file extension: %s\n", i+1, format.ApiName, format.Name, format.Extension)
}

promptText := fmt.Sprintf("Select the format to use for language files you download from Phrase (%v-%v", 1, len(formats))
promptText := fmt.Sprintf("Select the format to use for language files you download from Phrase Strings (%v-%v", 1, len(formats))
if cmd.FileFormat != nil && cmd.FileFormat.Name != "" {
promptText += fmt.Sprintf(" or leave blank to use the default, %s)", cmd.FileFormat.Name)
}
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/internal/paths/glob.go
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ func SplitAtDirGlobOperator(path, pattern string) (pathStart, patternStart, path
return
}

// Glob supports * and ** globbing according to https://help.phrase.com/phraseapp-for-developers/phraseapp-client/configuration#globbing
// See https://support.phrase.com/hc/en-us/sections/5784132012828
func Glob(pattern string) (matches []string, err error) {
pattern = filepath.Clean(pattern)
pattern = escape(pattern)
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/internal/paths/paths.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ func Validate(file, formatName, formatExtension string) error {
if formatExtension != "" && formatExtension != fileExtension {
return fmt.Errorf(
"File extension %q does not equal %q (format: %q) for file %q.\nFor more information see %s",
fileExtension, formatExtension, formatName, file, "https://help.phrase.com/supported-formats",
fileExtension, formatExtension, formatName, file, "https://support.phrase.com/hc/en-us/articles/5784070560412",
)
}

Expand Down
4 changes: 2 additions & 2 deletions clients/cli/cmd/internal/push.go
Original file line number Diff line number Diff line change
Expand Up @@ -427,8 +427,8 @@ func printCreateBranchQuestion(branch string) {
ct.ChangeColor(ct.Green, false, ct.None, false)
fmt.Printf("%s", branch)
ct.ResetColor()
fmt.Printf("'.\nThere currently is no branch in Phrase with this name.\n\n")
fmt.Printf("Should we create a new branch in Phrase with the same name and push to it? [y/N]: ")
fmt.Printf("'.\nThere currently is no branch in Phrase Strings with this name.\n\n")
fmt.Printf("Should we create a new branch in Phrase Strings with the same name and push to it? [y/N]: ")
}

func isYes(text string) bool {
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/internal/shared/urls.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package shared

const (
DocsConfigUrl = "https://help.phrase.com/phraseapp-for-developers/phraseapp-client/configuration"
DocsConfigUrl = "https://support.phrase.com/hc/en-us/sections/5784132012828"
)
4 changes: 2 additions & 2 deletions clients/cli/cmd/internal/updatechecker/update_checker.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ func (uc *Checker) Check() {
}

if stringz.ContainsAnySub(strings.ToLower(uc.version), []string{"dev", "test"}) {
fmt.Fprintf(uc.output, "You're running a development version (%s) of the Phrase client! Latest version is %s.\n", uc.version, latestVersion)
fmt.Fprintf(uc.output, "You're running a development version (%s) of the Phrase Strings client! Latest version is %s.\n", uc.version, latestVersion)
return
}

Expand All @@ -52,7 +52,7 @@ func (uc *Checker) Check() {
}

if version.LessThan(*latestVersion) {
fmt.Fprintf(uc.output, "Please consider updating the Phrase CLI client (%s < %s)\nYou can get the latest version from %s.\n", version, latestVersion, downloadPageURL)
fmt.Fprintf(uc.output, "Please consider updating the Phrase Strings CLI client (%s < %s)\nYou can get the latest version from %s.\n", version, latestVersion, downloadPageURL)
}
}

Expand Down
4 changes: 2 additions & 2 deletions clients/cli/cmd/internal/updatechecker/update_checker_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ func TestUpdateChecker_CheckForUpdate_withUpdateAvailable(t *testing.T) {

tuc.Check()

expected := "Please consider updating the Phrase CLI client (1.1.3 < 2.0.0)\n"
expected := "Please consider updating the Phrase Strings CLI client (1.1.3 < 2.0.0)\n"
expected += "You can get the latest version from https://phrase.com/cli.\n"

if out.String() != expected {
Expand All @@ -151,7 +151,7 @@ func TestUpdateChecker_CheckForUpdate_withDevVersion(t *testing.T) {

tuc.Check()

expected := "You're running a development version (1.1.3-dev) of the Phrase client! Latest version is 2.0.0.\n"
expected := "You're running a development version (1.1.3-dev) of the Phrase Strings client! Latest version is 2.0.0.\n"

if out.String() != expected {
t.Errorf("expected %q, got %q", expected, out.String())
Expand Down
6 changes: 3 additions & 3 deletions clients/cli/cmd/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ var (

rootCmd = &cobra.Command{
Use: "phrase",
Short: "Phrase is a translation management platform for software projects.",
Long: `You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account.`,
Short: "Phrase Strings is a translation management platform for software projects.",
Long: `You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.`,
}
)

func init() {
Config = &phrase.Config{
Debug: false,
UserAgent: "Phrase CLI (" + PHRASE_CLIENT_VERSION + ")",
UserAgent: "Phrase Strings CLI (" + PHRASE_CLIENT_VERSION + ")",
}

cobra.OnInitialize(initConfig)
Expand Down
2 changes: 1 addition & 1 deletion clients/cli/cmd/version.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func init() {

var versionCmd = &cobra.Command{
Use: "version",
Short: "Print the version number of Phrase",
Short: "Print the version number of Phrase Strings",
Long: `All software has versions. This is Phrase's`,
Run: func(cmd *cobra.Command, args []string) {
fmt.Printf("%s\n", PHRASE_CLIENT_VERSION)
Expand Down
6 changes: 3 additions & 3 deletions clients/go/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -152,9 +152,9 @@ func (cfg *Config) UnmarshalYAML(unmarshal func(i interface{}) error) error {
return nil
}

const cfgValueErrStr = "configuration key %q has invalid value: %T\nsee https://help.phrase.com/articles/2185247-configuration"
const cfgKeyErrStr = "configuration key %q has invalid type: %T\nsee https://help.phrase.com/articles/2185247-configuration"
const cfgInvalidKeyErrStr = "configuration key %q unknown\nsee https://help.phrase.com/articles/2185247-configuration"
const cfgValueErrStr = "configuration key %q has invalid value: %T\nsee https://support.phrase.com/hc/en-us/sections/5784132012828"
const cfgKeyErrStr = "configuration key %q has invalid type: %T\nsee https://support.phrase.com/hc/en-us/sections/5784132012828"
const cfgInvalidKeyErrStr = "configuration key %q unknown\nsee https://support.phrase.com/hc/en-us/sections/5784132012828"

func ValidateIsString(k string, v interface{}) (string, error) {
s, ok := v.(string)
Expand Down
2 changes: 1 addition & 1 deletion doc/_variables.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ $spacing8: 32px;
$borderRadius2: 2px;
$borderRadius3: 3px;

$colorAccentBackground: #0091EB;
$colorAccentBackground: #03eab3;
$colorAccentForeground: #fff;
$colorPrimaryBorder: #DADADA;
$colorPrimaryForeground: #242424;
Expand Down
80 changes: 40 additions & 40 deletions doc/compiled.json

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions doc/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<html>
<head>
<meta charset="utf-8"> <!-- Important: rapi-doc uses utf8 charecters -->
<title>Phrase API Documentation</title>
<title>Phrase Strings API Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link href="./favicon-32x32.png?v=1" rel="icon" sizes="32x32" type="image/png">
<link href="./favicon-16x16.png?v=1" rel="icon" sizes="16x16" type="image/png">
Expand Down Expand Up @@ -33,7 +33,7 @@
on-nav-tag-click="show-description"
info-description-headings-in-navbar="true"
text-color="#242424"
primary-color="#0091EB"
primary-color="#333333"
regular-font="Source Sans Pro,Verdana,sans-serif"
mono-font="Menlo,monospace"
font-size="largest"
Expand All @@ -46,11 +46,11 @@
>

<div slot="nav-logo" class="nav-logo">
<img class="nav-logo__img" src="./phrase-logo.png" />
<img class="nav-logo__img" src="./phrase-logo.svg" />
</div>
<div slot="footer" class="footer">
<a class="footer__link" href="https://app.phrase.com/signup" target="_blank">Try Phrase</a>
<a class="footer__link" href="https://help.phrase.com/help" target="_blank">Help Center</a>
<a class="footer__link" href="https://support.phrase.com/help" target="_blank">Help Center</a>
<a class="footer__link" href="https://status.phrase.com/" target="_blank">System Status</a>
<a class="footer__link" href="https://phrase.com/privacy/" target="_blank">Privacy</a>
<a class="footer__link" href="https://phrase.com/terms/" target="_blank">Terms</a>
Expand Down
11 changes: 11 additions & 0 deletions doc/phrase-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 5 additions & 5 deletions intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Phrase is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase for your account.
Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account.

## API Endpoints

Expand All @@ -18,11 +18,11 @@ The API is only accessible via HTTPS and the current version is <code>v2</code>,

## Usage

[curl](http://curl.haxx.se/) is used primarily to send requests to Phrase in the examples. On most you'll find a second variant using the [Phrase API v2 client](https://phrase.com/cli/) that might be more convenient to handle. For further information check its [documentation](https://help.phrase.com/help/phrase-in-your-terminal).
[curl](http://curl.haxx.se/) is used primarily to send requests to Phrase Strings in the examples. On most you'll find a second variant using the [Phrase Strings API v2 client](https://phrase.com/cli/) that might be more convenient to handle. For further information check its [documentation](https://support.phrase.com/hc/en-us/articles/5808300599068).

## Use of HTTP Verbs

Phrase API v2 tries to use the appropriate HTTP verb for accessing each endpoint according to REST specification where possible:
Phrase Strings API v2 tries to use the appropriate HTTP verb for accessing each endpoint according to REST specification where possible:

<div class="table-responsive">
<table class="basic-table">
Expand Down Expand Up @@ -339,7 +339,7 @@ Status: 304 Not Modified

## JSONP

The Phrase API supports [JSONP](http://en.wikipedia.org/wiki/JSONP) for all GET requests in order to deal with cross-domain request issues. Just send a `?callback` parameter along with the request to specify the Javascript function name to be called with the response content:
The Phrase Strings API supports [JSONP](http://en.wikipedia.org/wiki/JSONP) for all GET requests in order to deal with cross-domain request issues. Just send a `?callback` parameter along with the request to specify the Javascript function name to be called with the response content:

```
$ curl "https://api.phrase.com/v2/projects?callback=myFunction"
Expand Down Expand Up @@ -378,7 +378,7 @@ $ curl "https://api.phrase.com/v2/projects?callback=myFunction&access_token=ACCE

## Usage examples

Learn how to work more efficiently with Phrase API v2 with these
Learn how to work more efficiently with Phrase Strings API v2 with these
workflow-oriented examples.

</div>
Expand Down
Loading

0 comments on commit 79c5638

Please sign in to comment.