diff options
author | Russ Cox <rsc@golang.org> | 2020-03-15 15:50:36 -0400 |
---|---|---|
committer | Russ Cox <rsc@golang.org> | 2020-03-17 20:58:46 +0000 |
commit | 972d42d925e6cae3f8eebd9b21d445e06c2eb386 (patch) | |
tree | 737af27f0d49318b612efec874b1d1328c699d1a /content/README | |
parent | faf1e2da2d911edc717993e8edb24fe88f99b2b5 (diff) |
content: rename articles to reinforce convention of short URLs
The Go blog started out on Blogger
(http://web.archive.org/web/20100325005843/http://blog.golang.org/).
Later, we moved to the current self-hosted blog server
with extra Go-specific functionality like playground snippets.
The old Blogger posts have very long URLs that Blogger chose
for us, such as "go-programming-language-turns-two" or
"two-go-talks-lexical-scanning-in-go-and", predating
the convention of giving posts shorter, more share-friendly,
typeable names.
The conversion of the old Blogger posts also predated
the convention of putting supporting files in a subdirectory.
The result is that although we've established new conventions,
you wouldn't know by listing the directory - the old Blogger
content presents a conflicting picture.
This commit renames the posts with very long names
to have shorter, more share-friendly names, and it moves
all supporting files to subdirectories. It also adds a README
documenting the conventions.
For example, blog.golang.org/go-programming-language-turns-two
is now blog.golang.org/2years, matching our more recent birthday
post URLs, and its supporting files are moved to the new 2years/ directory.
The old URLs redirect to the new ones.
Change-Id: I9f46a790c2c8fab8459aeda73d4e3d2efc86d88f
Reviewed-on: https://go-review.googlesource.com/c/blog/+/223599
Run-TryBot: Russ Cox <rsc@golang.org>
Reviewed-by: Andrew Bonventre <andybons@golang.org>
Diffstat (limited to 'content/README')
-rw-r--r-- | content/README | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/content/README b/content/README new file mode 100644 index 0000000..30e149c --- /dev/null +++ b/content/README @@ -0,0 +1,27 @@ +This directory holds Go blog articles, in *.article. +See https://pkg.go.dev/golang.org/x/tools/present?tab=doc +for documentation of the file format or look at any of the +articles for examples. + +Article file names should be short, amenable to being typed by hand in URLs. +Typically article file names are up to three words, separated by dashes. +A trailing year in the name typically does not have a dash before it. + +All supporting files for an article, even if there's only one, should be +placed in a directory named for the article (minus the .article suffix). + +If your article has code that is meant to be a working program, please use +.code, or ideally .play, to load the lines from a supporting .go file. +That way you can easily check that the .go file, and therefore the code +in your article, still works. + +Please use .image and .video to embed images and videos, +instead of using raw HTML tags. The .image and .video commands +provide a way to adjust the implementation of those embeddings +all in one place. + +Please use .html when it is necessary to add large blocks of HTML, +keeping article text in the main .article file. Another important use of +.html is to factor out an HTML snippet that appears multiple times. +Short HTML sequences, like <div><center> or </div></center>, +are fine to put directly in the article files. |