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.

Sign up for GitHub

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

Jump to bottom

Update "Developers" section re recent build changes #319

Closed
11 tasks done
phillxnet opened this issue Nov 18, 2021 · 3 comments · Fixed by #321
Closed
11 tasks done

Update "Developers" section re recent build changes #319

phillxnet opened this issue Nov 18, 2021 · 3 comments · Fixed by #321
Assignees
@phillxnet

Comments

@phillxnet
Copy link
Member

phillxnet commented Nov 18, 2021 •
edited
Loading

Due to a change/update in authentication mechanism re pypi we have had to alter our build procedure a little. Mainly due to our use of a now outdated python 2 based build system. See: rockstor/rockstor-core#1877

Previously we setup and executed our source build by:

bootstrap.py -c buildout.cfg
buildout -N -c buildout.cfg

This was affected by staggered brown outages intended to inform those using older build systems such as ours that changes were afoot. These changes have now become permanent and represent a deprecation of non-SNI compatible clients.

Update our doc entries to reflect the work around we are now using:

zypper --non-interactive install python2-pip
pip2 install zc.buildout
buildout bootstrap

Thanks to @FroggyFlox for researching the origin of these difficulties and presenting the above work around. Much appreciated.

Apologies for the delay in establishing this issue.

Components:

  • Move to suggesting the use of a v4 install instance. Contributors should be familiar with this install and it has many of the rpm's dependencies and little else so is a good start.
  • add install command for required developer dependencies- Build VM section in contribute page.
  • Fix above detailed build command chanages.
  • Be opinionated about the build directory, there's no harm and it's a quicker read.
  • Remove dead YouTube link in this section.
  • Remove some overly chatty bits in Local git repo setup section.
  • Remove adding name to authors file as we have now only 2 in there but 35 git contributors. It is suspected that this is due to the first 2 including an email. This also represents an overhead for those doing small patches.
  • Update /opt/rockstor-dev/var/log "ls -la" entry as we now have no ztask.log but a new entry or two for huey.
  • Add systemd services info.
  • Add updating info/context re rpm.
  • Move contribute.rst to Semantic Liefeeds.
@phillxnet phillxnet self-assigned this Nov 18, 2021
@FroggyFlox
Copy link
Member

Thanks a lot, @phillxnet !
Note that from memory I believe we use zc.sourcerelease only for rpm building and is not needed for buildout.cfg.

@phillxnet
Copy link
Member Author

@FroggyFlox Thanks, editing accordingly.

@phillxnet
Copy link
Member Author

I am currently working in this issue.

@phillxnet phillxnet mentioned this issue Nov 20, 2021
Closed
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 20, 2021
@phillxnet
Update "Developers" section re recent build changes rockstor#319
fe77ae5 
Due to a change/update in authentication mechanism re pypi we have had
to alter our build procedure a little. Reflect these changes in our
developer contributor section.

Includes improvements re:
- Brevity.
- Readability.
- Consistency.
- Update to V4 "Built on openSUSE" base os.
- Preference for using a rockstor-installer derived instance.
- Removed dead and distracting YouTube links.
- Removed redundant and completely neglected AUTHORS link to
rockstor-core.
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
save point re re-word and better segregation of build steps rockstor#319
f43ed56 


Still pending local proof test run and some more tweaks to aid in faster
on-barding.
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
re-arrange instructions / assumptions section for brevity rockstor#319
c59d8ac 
We end up repeating ourselves otherwise.
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
save point re reword & command line clean-up / walk through rockstor#319
d33dec5 


Up to "Code Build" section
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
Add info on associated systemd services rockstor#319
a5199d0 
Includes misc re-wording and re-formatting.
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
Add info on updating re rpm and source installs rockstor#319
2ba2801
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
complete semantic line feed changes in contribute.rst rockstor#319
6ed2dab 
includes more re-wording dir list updates and consistency changes.
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 21, 2021
@phillxnet
Update "Developers" section re recent build changes rockstor#319
45dc451 
Due to a change/update in authentication mechanism re pypi we have had
to alter our build procedure a little. Reflect these changes in our
developer contributor section.

Includes improvements re:
- Brevity.
- Readability.
- Consistency.
- Ordering.
- Update to V4 "Built on openSUSE" base os.
- Preference for using a rockstor-installer derived instance.
- Removed dead and distracting YouTube links.
- Removed redundant and completely neglected AUTHORS link to
rockstor-core.
- Better segregation and interdependency explanation of build steps.
- Improve on-boarding ease/speed via tips to enable cut-paste setups.
- Add info on associated systemd services.
- Add info on updating re rpm and source installs.
- Move contribute.rst to semantic line feeds.
@phillxnet phillxnet mentioned this issue Nov 21, 2021
Merged
phillxnet added a commit to phillxnet/rockstor-doc that referenced this issue Nov 22, 2021
@phillxnet
fix link move doc code blocks to console & normalise console prompt r…
9c863c4 
…ockstor#319

Includes:
- Adding a directory push pop around python3 http server command.
phillxnet added a commit that referenced this issue Nov 22, 2021
@phillxnet
Merge pull request #321 from phillxnet/319_Update_"Developers"_sectio…
73b56c2 
…n_re-recent_build_changes

Update "Developers" section re recent build changes #319
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@phillxnet phillxnet

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update "Developers" section re recent build changes #319 phillxnet/rockstor-doc
2 participants
@phillxnet @FroggyFlox