Comments (7)
taylorsilva
commented on July 17, 2024
1
This is fantastic! I've been writing/updating most of the docs and I'm not a docs writer, so it's been hard for me to see where to further take the docs to make them better. This is exactly what we need.
I like the proposed breakdown between the types of users and the docs meant for each group. I think it would be a huge improvement over the current structure.
I've got a lot going on right now, so definitely don't have time to work on this in the short-term, but happy to shepherd any PR's you start.
from docs.
taylorsilva
commented on July 17, 2024
1
It's building fine for me now on a new machine (macos) with go 1.17.2
from docs.
tomschr
commented on July 17, 2024
Thank you for your kind word, Taylor. I hope my text wasn't too mean or discouraged you. Tried to be quite the opposite! I would really like to see the documentation as a proud testament of all the possible things that can be done with Concourse.
I'm happy if my proposal makes sense to you. Even if it is still a little half-baked. π
The reason for this issue is, I'm a beginner. Perhaps I'm a good candidate for all the traps and mistakes you can make. π The Getting Started served me quite well, but then I got confused where to go and felt a bit lost. Maybe it was just me.
I can try to kickstart the process a bit. However, when I try to build the documentation with ./scripts/build -s 8000 as written in the README, I got an errors (error loading module requirements). I use Go version go1.12.17 on my machine.
from docs.
taylorsilva
commented on July 17, 2024
I hope my text wasn't too mean or discouraged you.
It had quite the opposite effect! It was all quality, constructive feedback. It made me feel energized and excited about the docs! π
I use Go version go1.12.17 on my machine.
Maybe try running go mod download first?
from docs.
tomschr
commented on July 17, 2024
I hope my text wasn't too mean or discouraged you.
It had quite the opposite effect! It was all quality, constructive feedback. It made me feel energized and excited about the docs! π
Haha, that's great! π π
I use Go version go1.12.17 on my machine.
Maybe try running
go mod downloadfirst?
I've tried that, see the log below. I run it on openSUSE Leap 15.2. I also added the log from the ./scripts/build command.
Not sure what I did wrong. Used the instructions from the README.
Log from "go mod download" (click me)
$ LANG=C go mod download
go: finding golang.org/x/tools v0.0.0-20201218024724-ae774e9781d2
go: finding golang.org/x/sys v0.0.0-20191026070338-33540a1f6037
go: finding golang.org/x/sys v0.0.0-20201218084310-7d0127a74742
go: finding golang.org/x/net v0.0.0-20210224082022-3d97a244fca7
go: finding golang.org/x/net v0.0.0-20201216054612-986b41b23924
go: finding golang.org/x/net v0.0.0-20200202094626-16171245cfb2
go: finding golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
go: finding golang.org/x/text v0.3.4
go: finding gopkg.in/alecthomas/kingpin.v2 v2.2.6
go: finding gopkg.in/yaml.v2 v2.4.0
go: golang.org/x/[email protected]: unknown revision v0.3.4
go: finding golang.org/x/sys v0.0.0-20200413165638-669c56c373c4
go: gopkg.in/alecthomas/[email protected]: unknown revision v2.2.6
go: finding golang.org/x/text v0.3.2
go: golang.org/x/[email protected]: unknown revision v0.3.2
go: finding golang.org/x/sys v0.0.0-20200519105757-fe76b779f299
go: gopkg.in/[email protected]: unknown revision v2.4.0
go: finding golang.org/x/sys v0.0.0-20181116152217-5ac8a444bdc5
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/sys refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/76a8992ccba6d77c6bcf031ff2b6d821cf232e4ad8d1f2362404fbd0a798d846: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/sys/' not found
go: finding golang.org/x/net v0.0.0-20190613194153-d28f0bde5980
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/net refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/4a22365141bc4eea5d5ac4a1395e653f2669485db75ef119e7bbec8e19b12a21: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/net/' not found
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/tools refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/b44680b3c3708a854d4c89f55aedda0b223beb8d9e30fba969cefb5bd9c1e843: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/tools/' not found
go: golang.org/x/[email protected]: unknown revision 7d0127a74742
go: finding golang.org/x/tools v0.0.0-20190830223141-573d9926052a
go: golang.org/x/[email protected]: unknown revision 986b41b23924
go: finding gopkg.in/yaml.v2 v2.2.4
go: gopkg.in/[email protected]: unknown revision v2.2.4
go: finding golang.org/x/sys v0.0.0-20190422165155-953cdadca894
go: golang.org/x/[email protected]: unknown revision 573d9926052a
go: golang.org/x/[email protected]: unknown revision 16171245cfb2
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/oauth2 refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/107b619a0a978da90476a85ea79f10cd55d87ea7b773b72c57d92167dbaf4d15: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/oauth2/' not found
go: golang.org/x/[email protected]: unknown revision d28f0bde5980
go: golang.org/x/[email protected]: unknown revision 669c56c373c4
go: golang.org/x/[email protected]: unknown revision fe76b779f299
go: golang.org/x/[email protected]: unknown revision 5ac8a444bdc5
go: golang.org/x/[email protected]: unknown revision 953cdadca894
go: finding golang.org/x/mod v0.4.0
go: finding golang.org/x/sync v0.0.0-20181108010431-42b317875d0f
go: golang.org/x/[email protected]: unknown revision v0.4.0
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/sync refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/55179c5d8c4db2eaed9fae4682d4c84a1fd3612df666b372bef3bbb997c9601f: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/sync/' not found
go: error loading module requirements
Log from ./scripts/build -s 8000 (click me)
$ LANG=C ./scripts/build -s 8000
go: finding golang.org/x/sync v0.0.0-20181108010431-42b317875d0f
go: finding golang.org/x/net v0.0.0-20210224082022-3d97a244fca7
go: finding golang.org/x/oauth2 v0.0.0-20190604053449-0f29369cfe45
go: finding golang.org/x/net v0.0.0-20190613194153-d28f0bde5980
go: finding golang.org/x/sys v0.0.0-20191026070338-33540a1f6037
go: finding golang.org/x/sys v0.0.0-20201218084310-7d0127a74742
go: finding golang.org/x/text v0.3.4
go: finding golang.org/x/mod v0.4.0
go: finding golang.org/x/tools v0.0.0-20201218024724-ae774e9781d2
go: finding gopkg.in/alecthomas/kingpin.v2 v2.2.6
go: golang.org/x/[email protected]: unknown revision v0.4.0
go: golang.org/x/[email protected]: unknown revision v0.3.4
go: gopkg.in/alecthomas/[email protected]: unknown revision v2.2.6
go: finding golang.org/x/net v0.0.0-20180218175443-cbe0f9307d01
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/sync refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/55179c5d8c4db2eaed9fae4682d4c84a1fd3612df666b372bef3bbb997c9601f: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/sync/' not found
go: finding golang.org/x/sys v0.0.0-20200413165638-669c56c373c4
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/net refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/4a22365141bc4eea5d5ac4a1395e653f2669485db75ef119e7bbec8e19b12a21: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/net/' not found
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/tools refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/b44680b3c3708a854d4c89f55aedda0b223beb8d9e30fba969cefb5bd9c1e843: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/tools/' not found
go: finding golang.org/x/sys v0.0.0-20190422165155-953cdadca894
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/oauth2 refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/107b619a0a978da90476a85ea79f10cd55d87ea7b773b72c57d92167dbaf4d15: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/oauth2/' not found
go: golang.org/x/[email protected]: unknown revision d28f0bde5980
go: finding golang.org/x/tools v0.0.0-20190830223141-573d9926052a
go: golang.org/x/[email protected]: unknown revision cbe0f9307d01
go: finding golang.org/x/net v0.0.0-20201202161906-c7110b5ffcbb
go: golang.org/x/[email protected]: unknown revision 573d9926052a
go: finding golang.org/x/net v0.0.0-20200202094626-16171245cfb2
go: golang.org/x/[email protected]: unknown revision c7110b5ffcbb
go: finding golang.org/x/sys v0.0.0-20190904154756-749cb33beabd
go: golang.org/x/[email protected]: unknown revision 16171245cfb2
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/sys refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/76a8992ccba6d77c6bcf031ff2b6d821cf232e4ad8d1f2362404fbd0a798d846: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/sys/' not found
go: finding golang.org/x/net v0.0.0-20201216054612-986b41b23924
go: golang.org/x/[email protected]: unknown revision 7d0127a74742
go: golang.org/x/[email protected]: unknown revision 986b41b23924
go: finding golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543
go: golang.org/x/[email protected]: unknown revision 669c56c373c4
go: golang.org/x/[email protected]: unknown revision 953cdadca894
go: golang.org/x/[email protected]: unknown revision 749cb33beabd
go: finding gopkg.in/tomb.v1 v1.0.0-20141024135613-dd632973f1e7
go: finding gopkg.in/yaml.v2 v2.2.4
go: finding gopkg.in/yaml.v2 v2.4.0
go: finding gopkg.in/yaml.v2 v2.3.0
go: golang.org/x/[email protected]: git fetch -f https://go.googlesource.com/xerrors refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/3dae2e2383f75162530e523fa60c46a0150bec632a2a57ec3fee7fac3fc3648c: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/xerrors/' not found
go: gopkg.in/[email protected]: git fetch -f https://gopkg.in/tomb.v1 refs/heads/*:refs/heads/* refs/tags/*:refs/tags/* in /home/toms/go/pkg/mod/cache/vcs/95acae1f863cd3698780e83ddc42f6ad6cd0ab1cb79143808a7de7300ae4df93: exit status 128:
remote: Not Found
fatal: repository 'https://github.com///gopkg.in/tomb.v1/' not found
go: gopkg.in/[email protected]: unknown revision v2.2.4
go: gopkg.in/[email protected]: unknown revision v2.4.0
go: gopkg.in/[email protected]: unknown revision v2.3.0
go: error loading module requirements
from docs.
taylorsilva
commented on July 17, 2024
That's weird that you're getting stuff like
remote: Not Found
fatal: repository 'https://github.com///go.googlesource.com/sys/' not found
I'm on a new machine right now and I don't get any errors from go mod download. I'm using go 1.17.2. Might be worth trying to upgrade to 1.16. I think 1.16 had some changes related to go mod.
I'm also having trouble building on this new machine that hasn't built the docs before.
./scripts/build
INFO[0000] plugin registered plugin=baselit
INFO[0000] plugin registered plugin=baselit
INFO[0000] plugin registered plugin=concourse-docs
INFO[0000] plugin registered plugin=resource-type-list
WARN[0000] no $GITHUB_TOKEN set; using filler download links
WARN[0000] no $GITHUB_TOKEN set; using filler RFCs
lit/docs/steps.lit:1386: parse error: no match found, expected: [\\{}] or [a-z-]
1386| \required-attribute{steps}{[step]}{
^
Not sure what that's about π€
EDIT: nvm, found out it's due to a rogue slash and probably the latest version of booklit changing a bit too
from docs.
tomschr
commented on July 17, 2024
Thanks for all the tips, updating to go1.17 and adding ~/go/bin into PATH helped.
I forked the repo already, will create a branch, and try to work a bit on the idea. I don't know where it leads us. When I will have something to show, I'll come back and will notify you.
from docs.
Related Issues (20)
- `fly -t tutorial builds | grep check` doesn't return anything. HOT 1
- CONCOURSE_POLICY_CHECK_FILTER_HTTP_METHODS is wrong HOT 2
- Switch our docs to use a fork of booklit
- Small typo ran -> run
- Failure when going through the tutorial and trying to access localhost Concourse HOT 8
- Document syslog format
- Update prometheus metrics list
- Update docs for fewest container placment strategy
- tutorial-inputs-outputs.html has broken iframe HOT 1
- Broken link on the Job & task hooks example page HOT 1
- Where is the instruction for TLS configurationοΌ
- Rename Job Documentation improvement
- Blog is offline due to certificate problems HOT 2
- [Docs] Is there a way to generate a book for it? HOT 3
- Update docs with Concourse hermetic feature
- Fly CLI docs are incomplete HOT 1
- Pipeline naming standards not documented
- "Building and Pushing an Image" wrong put parameter
- Hard Dependency on iptables, Unable To Start on Fedora 38 Host HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. πππ
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google β€οΈ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.