Skip to content

Commit

Permalink
Consistently use lowercase otf throughout
Browse files Browse the repository at this point in the history
  • Loading branch information
leg100 committed Oct 30, 2022
1 parent 428ecb8 commit ecf15e4
Show file tree
Hide file tree
Showing 12 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions ALGORITHMS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Concepts

Notes on various concepts in use by TFE/TFC/oTF.
Notes on various concepts in use by TFE/TFC/otf.

## Run Status/State

https://www.terraform.io/cloud-docs/api-docs/run#run-states

A run begins life in the `pending` state. The next state (in oTF) is `plan_queued`, indicating it's ready to enter the plan phase and that it's currently waiting in the global queue (see below). A run is switched from `pending` to `plan_queued` if:
A run begins life in the `pending` state. The next state (in otf) is `plan_queued`, indicating it's ready to enter the plan phase and that it's currently waiting in the global queue (see below). A run is switched from `pending` to `plan_queued` if:

* it's reached the front of the workspace queue (see below)
* it's a speculative run (i.e. plan-only) in which case the switch occurs immediately
Expand All @@ -31,7 +31,7 @@ Note: the workspace queue is a queue of *runs* whereas the global queue is a que

## Agents

Note: this only applies to oTF.
Note: this only applies to otf.

Agents execute run phases i.e. plans and applies.

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,13 +97,13 @@ These steps will get you started with running everything on your local system. Y
sudo update-ca-certificates
```

1. Ensure you have access to a postgresql server. oTF assumes it's running locally on a unix domain socket in `/var/run/postgresql`. Create a database named `otf`:
1. Ensure you have access to a postgresql server. otf assumes it's running locally on a unix domain socket in `/var/run/postgresql`. Create a database named `otf`:
```bash
createdb otfd
```
1. Run the oTF daemon:
1. Run the otf daemon:
```bash
otfd --ssl --cert-file=cert.crt --key-file=key.pem
Expand Down
2 changes: 1 addition & 1 deletion environment.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import (
"io"
)

// Environment provides a Job with access to various oTF services, a working
// Environment provides a Job with access to various otf services, a working
// directory, and the ability to invoke arbitrary commands and go functions.
// Invoking commands and functions via the environment means the environment can
// handle canceling them if necessary.
Expand Down
2 changes: 1 addition & 1 deletion events.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const (
// EventType identifies the type of event
type EventType string

// Event represents an event in the lifecycle of an oTF resource
// Event represents an event in the lifecycle of an otf resource
type Event struct {
Type EventType
Payload interface{}
Expand Down
2 changes: 1 addition & 1 deletion hack/create_and_upload_configuration_version.bash
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ then
exit 1
fi

# oTF API doesn't yet verify tokens
# otf API doesn't yet verify tokens
TOKEN=dummy

HOST=localhost:8080
Expand Down
4 changes: 2 additions & 2 deletions http/html/app.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ func NewConfigFromFlags(flags *pflag.FlagSet) *Config {
return &cfg
}

// Application is the oTF web app.
// Application is the otf web app.
type Application struct {
// Static asset server
staticServer http.FileSystem
// oTF service accessors
// otf service accessors
otf.Application
// path prefix for all URLs
pathPrefix string
Expand Down
2 changes: 1 addition & 1 deletion http/html/error.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const errorTemplateContent = `
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>error | oTF</title>
<title>error | otf</title>
<style>
pre {
margin: auto;
Expand Down
2 changes: 1 addition & 1 deletion http/html/html.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Package html provides the oTF web app, serving up HTML formatted pages and associated assets (CSS, JS, etc).
Package html provides the otf web app, serving up HTML formatted pages and associated assets (CSS, JS, etc).
*/
package html

Expand Down
4 changes: 2 additions & 2 deletions http/html/static/templates/layout.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
{{ block "stylesheet" . }}{{ end }}
<link rel="stylesheet" href="{{ addHash "/static/css/main.css" }}">
<script src="{{ addHash "/static/js/main.js" }}"></script>
<title>{{ template "title" }} | oTF</title>
<title>{{ template "title" }} | otf</title>
</head>
<body>
<header>
<nav class="navbar">
<div class="logo">
<a href="/">oTF</a>
<a href="/">otf</a>
</div>
<div class="nav-links">
<ul>
Expand Down
2 changes: 1 addition & 1 deletion http/html/view_engine.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ type view struct {
request *http.Request
// pop flash message in template
flashPopper func() *flash
// oTF version string in footer
// otf version string in footer
Version string
}

Expand Down
10 changes: 5 additions & 5 deletions otf.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var reStringID = regexp.MustCompile(`^[a-zA-Z0-9\-\._]+$`)
// A regular expression used to validate semantic versions (major.minor.patch).
var reSemanticVersion = regexp.MustCompile(`^[0-9]+\.[0-9]+\.[0-9]+$`)

// Application provides access to the oTF application services
// Application provides access to the otf application services
type Application interface {
OrganizationService
WorkspaceService
Expand All @@ -54,7 +54,7 @@ type LockableApplication interface {
WithLock(ctx context.Context, id int64, cb func(Application) error) error
}

// DB provides access to oTF database
// DB provides access to otf database
type DB interface {
// Tx provides a transaction within which to operate on the store.
Tx(ctx context.Context, tx func(DB) error) error
Expand All @@ -74,7 +74,7 @@ type DB interface {
AgentTokenStore
}

// Identity is an identifiable oTF entity.
// Identity is an identifiable otf entity.
type Identity interface {
// Human friendly identification of the entity.
String() string
Expand All @@ -89,7 +89,7 @@ func UInt(i uint) *uint { return &i }
func Bool(b bool) *bool { return &b }
func Time(t time.Time) *time.Time { return &t }

// CurrentTimestamp is *the* way to get a current timestamps in oTF and
// CurrentTimestamp is *the* way to get a current timestamps in otf and
// time.Now() should be avoided.
//
// We want timestamps to be rounded to nearest
Expand Down Expand Up @@ -221,7 +221,7 @@ func (*AppUser) ID() string { return "app-

// Absolute returns an absolute URL for the given path. It uses the http request
// to determine the correct hostname and scheme to use. Handles situations where
// oTF is sitting behind a reverse proxy, using the X-Forwarded-* headers the
// otf is sitting behind a reverse proxy, using the X-Forwarded-* headers the
// proxy sets.
//
// TODO: move to http pkg
Expand Down
2 changes: 1 addition & 1 deletion user.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ var (
SiteAdmin = User{id: SiteAdminID, username: "site-admin"}
)

// User represents an oTF user account.
// User represents an otf user account.
type User struct {
// ID uniquely identifies users
id string
Expand Down

0 comments on commit ecf15e4

Please sign in to comment.