Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TFB-1487] Migrate Jira and Blueprint Documentation to Docs Repo #29

Closed
pono opened this issue Sep 24, 2019 · 8 comments
Closed

[TFB-1487] Migrate Jira and Blueprint Documentation to Docs Repo #29

pono opened this issue Sep 24, 2019 · 8 comments
Assignees

Comments

@pono
Copy link
Contributor

pono commented Sep 24, 2019

Currently, the Jira workflows and Blueprint submission process for developers are documented in Google Docs.

https://docs.google.com/document/d/1UWIzZZOzTR8zZeTUOpV5pPzq1EcCPrS-F2GkYysOpR8/edit?usp=sharing
https://docs.google.com/document/d/1hYhaPmQEN4V4ZeLxruloIshnQ6yd05vNkcKqhRqCnIw/edit#heading=h.h3vxu6qloos

For consistency and to allow new developers to easily find this required documentation, the purpose of this task is to move these documents to the required format in the docs repository in the Contributor folder.

https://gerrit.tungsten.io/r/admin/repos/docs&quot

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Darien has sent over an initial patch for this: https://gerrit.tungsten.io/r/c/docs/+/50

It was a straight translation to rST, so it needs updating to better reflect the new TF world, but it's a good start.

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Update from 2020-02-06 docs call: Lots of new comments on the patch. Will iterate later today.

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Making progress!

I'm trying to update my patch, but I need to work on a Gerrit issue. Suggestions welcome.

$ git push origin HEAD:refs/for/master

Enumerating objects: 70, done.

Counting objects: 100% (59/59), done.

Delta compression using up to 8 threads

Compressing objects: 100% (28/28), done.

Writing objects: 100% (30/30), 92.49 KiB | 10.28 MiB/s, done.

Total 30 (delta 12), reused 0 (delta 0)

remote: Resolving deltas: 100% (12/12)

_remote: Processing changes: refs: 1, done _

To ssh://gerrit.tungsten.io:29418/docs

! [remote rejected] HEAD -> refs/for/master (commit 432fb60: you are not allowed to upload merges)

error: failed to push some refs to 'ssh://dhirotsu@gerrit.tungsten.io:29418/docs'

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Sounds like Casey Cain might be running into this as well. I'll report any updates as they come.

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Darien Hirotsu What have you tried already? I found some pointers in a google search but they won't help if you've already found them.

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Still hitting issues. Things not passing unit tests in tox. Will add the output here so people can search for it.

Darien Hirotsuwill look into breaking this up into smaller patches and trying to get them to land separately, to try to move this forward in tinier steps.

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Here's an example. I have multiple patches waiting to land, so I'm running into the same issue on the current head commit when I run our unit tests.

I'll try breaking this monolithic change to land individual changes faster.

Warning, treated as error:

/Users/dhirotsu/git/test/temp/docs/manual-cla-admin.rst:26:Title underline too short.

The cla@lists.tungsten.io Mailing List


ERROR: InvocationError for command /Users/dhirotsu/git/test/temp/docs/.tox/docs/bin/sphinx-build -W -b html -n -d /Users/dhirotsu/git/test/temp/docs/.tox/docs/tmp/doctrees ./ _build/html (exited with code 2)

@pono
Copy link
Contributor Author

pono commented Jul 16, 2020

Looks like it needs six more -'s to complete the underline under "Mailing List". Wanna give that a try (and check other headers to make sure they have the right number of underline characters) and see whether it helps get it through the build?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants