Project

General

Profile

Actions

action #114325

open

publish docu

Added by lkocman about 2 years ago. Updated over 1 year ago.

Status:
In Progress
Priority:
Normal
Assignee:
Target version:
Start date:
2022-07-19
Due date:
% Done:

0%

Estimated time:
(Total: 0.00 h)

Description

doc.opensuse.org

https://en.opensuse.org/SDB:Official_documentation

Ping Frank Sundermeyer or Lukas Kucharczyk about it


Subtasks 2 (2 open0 closed)

action #114328: update wiki pagesBlocked2022-07-19

Actions
action #114331: move previous release to archiveNew2022-07-19

Actions
Actions #1

Updated by lkocman over 1 year ago

  • Assignee set to lkocman

I'm on this one with Frank

Frank updated https://github.com/openSUSE/doc-o-o/pull/27

and I did the deployment (with heroes vpn on, and requested accesses from heroes to pinot-o-o/communty-o-o. doc.opensuse.org now displays 15.5 but I have to figure out what went wrong with "set_current_version" at the bottom.

lkocman@localhost:~/Workspace/opensuse/doc-o-o> bundle install --path vendor/bundle
Fetching gem metadata from https://rubygems.org/...........
Fetching https://github.com/ashmaroli/jekyll-locale.git
Fetching https://github.com/opensuse/jekyll-theme.git
Fetching public_suffix 4.0.6
Installing public_suffix 4.0.6
Fetching addressable 2.8.0
Installing addressable 2.8.0
Using bundler 1.16.1
Fetching colorator 1.1.0
Installing colorator 1.1.0
Fetching concurrent-ruby 1.1.9
Installing concurrent-ruby 1.1.9
Fetching eventmachine 1.2.7
Installing eventmachine 1.2.7 with native extensions
Fetching http_parser.rb 0.8.0
Installing http_parser.rb 0.8.0 with native extensions
Fetching em-websocket 0.5.3
Installing em-websocket 0.5.3
Fetching ffi 1.15.5
Installing ffi 1.15.5 with native extensions
Fetching forwardable-extended 2.6.0
Installing forwardable-extended 2.6.0
Fetching i18n 1.8.11
Installing i18n 1.8.11
Fetching sassc 2.4.0
Installing sassc 2.4.0 with native extensions
Fetching jekyll-sass-converter 2.1.0
Installing jekyll-sass-converter 2.1.0
Fetching rb-fsevent 0.11.0
Installing rb-fsevent 0.11.0
Fetching rb-inotify 0.10.1
Installing rb-inotify 0.10.1
Fetching listen 3.7.1
Installing listen 3.7.1
Fetching jekyll-watch 2.2.1
Installing jekyll-watch 2.2.1
Fetching rexml 3.2.5
Installing rexml 3.2.5
Fetching kramdown 2.3.1
Installing kramdown 2.3.1
Fetching kramdown-parser-gfm 1.1.0
Installing kramdown-parser-gfm 1.1.0
Fetching liquid 4.0.3
Installing liquid 4.0.3
Fetching mercenary 0.4.0
Installing mercenary 0.4.0
Fetching pathutil 0.16.2
Installing pathutil 0.16.2
Fetching rouge 3.27.0
Installing rouge 3.27.0
Fetching safe_yaml 1.0.5
Installing safe_yaml 1.0.5
Fetching unicode-display_width 1.8.0
Installing unicode-display_width 1.8.0
Fetching terminal-table 2.0.0
Installing terminal-table 2.0.0
Fetching jekyll 4.2.1
Installing jekyll 4.2.1
Fetching jekyll-archives 2.2.1
Installing jekyll-archives 2.2.1
Using jekyll-locale 0.5.1 from https://github.com/ashmaroli/jekyll-locale.git (at master@dc5c46c)
Fetching jekyll-paginate 1.1.0
Installing jekyll-paginate 1.1.0
Using jekyll-theme-opensuse 0.7.1 from https://github.com/opensuse/jekyll-theme.git (at master@cd9f092)
Bundle complete! 3 Gemfile dependencies, 32 gems now installed.
Bundled gems are installed into `./vendor/bundle`
lkocman@localhost:~/Workspace/opensuse/doc-o-o> ls
archive  _config.yml  development       doc-config  Gemfile.lock      _includes   _layouts  Makefile      README.md  tw-docs-config
assets   _data        doc-build-script  Gemfile     htaccess-doc-o-o  index.html  LICENSE   publishusers  rn-config  vendor
lkocman@localhost:~/Workspace/opensuse/doc-o-o> make build
bundle exec jekyll build
Configuration file: /home/lkocman/Workspace/opensuse/doc-o-o/_config.yml
 Theme Config file: /home/lkocman/Workspace/opensuse/doc-o-o/vendor/bundle/ruby/2.5.0/bundler/gems/jekyll-theme-cd9f09233373/_config.yml
            Source: /home/lkocman/Workspace/opensuse/doc-o-o
       Destination: /home/lkocman/Workspace/opensuse/doc-o-o/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.058 seconds.
 Auto-regeneration: disabled. Use --watch to enable.
cp "htaccess-doc-o-o" "_site/.htaccess"
lkocman@localhost:~/Workspace/opensuse/doc-o-o> make upload
bundle exec jekyll build
Configuration file: /home/lkocman/Workspace/opensuse/doc-o-o/_config.yml
 Theme Config file: /home/lkocman/Workspace/opensuse/doc-o-o/vendor/bundle/ruby/2.5.0/bundler/gems/jekyll-theme-cd9f09233373/_config.yml
            Source: /home/lkocman/Workspace/opensuse/doc-o-o
       Destination: /home/lkocman/Workspace/opensuse/doc-o-o/_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
                    done in 0.059 seconds.
 Auto-regeneration: disabled. Use --watch to enable.
cp "htaccess-doc-o-o" "_site/.htaccess"
test -s /home/lkocman/Workspace/opensuse/doc-o-o/publishusers && source /home/lkocman/Workspace/opensuse/doc-o-o/publishusers; \
if [[ $userdoc ]] && [[ $port ]] && [[ $server ]]; then \
  echo "Syncing documentation."; \
  rsync -lr -v "_site/" -e "ssh -p $port" ${userdoc}@${server}:doc.opensuse.org/htdocs/ ; \
else \
  exit 1; \
fi
Syncing documentation.
The authenticity of host 'community.infra.opensuse.org (192.168.47.6)' can't be established.
ECDSA key fingerprint is SHA256:RIdKjToNsiRO6+3+Q2NIbUkr9rqsBd76Z+sgTbTCFjQ.
Are you sure you want to continue connecting (yes/no/[fingerprint])? yes
Warning: Permanently added 'community.infra.opensuse.org,192.168.47.6' (ECDSA) to the list of known hosts.
sending incremental file list
.htaccess
index.html
archive/index.html
assets/css/app.css
assets/css/main.css
assets/images/cover-autoyast.svg
assets/images/cover-gnome.svg
assets/images/cover-reference.svg
assets/images/cover-release.svg
assets/images/cover-security.svg
assets/images/cover-startup.svg
assets/images/cover-tuning.svg
assets/images/cover-virtualization.svg
de/index.html
de/archive/index.html
de/development/index.html
development/index.html
doc-config/bin/set_current_version
es/index.html
es/archive/index.html
es/development/index.html
fr/index.html
fr/archive/index.html
fr/development/index.html
hi/index.html
hi/archive/index.html
hi/development/index.html
it/index.html
it/archive/index.html
it/development/index.html
ja/index.html
ja/archive/index.html
ja/development/index.html
pt-BR/index.html
pt-BR/archive/index.html
pt-BR/development/index.html
rn-config/bin/update_release_notes
rn-config/etc/releasenotes
rn-config/etc/update_release_notes.conf
tw-docs-config/bin/update_tw_docs
tw-docs-config/systemd/update_tw_docs.service
tw-docs-config/systemd/update_tw_docs.timer
uk/index.html
uk/archive/index.html
uk/development/index.html
zh-CN/index.html
zh-CN/archive/index.html
zh-CN/development/index.html

sent 275,695 bytes  received 11,264 bytes  18,513.48 bytes/sec
total size is 1,272,413  speedup is 4.43
lkocman@localhost:~/Workspace/opensuse/doc-o-o> make set_docs_current_version
test -s /home/lkocman/Workspace/opensuse/doc-o-o/publishusers && source /home/lkocman/Workspace/opensuse/doc-o-o/publishusers; \
if [[ $userdoc ]] && [[ $port ]] && [[ $server ]]; then \
  echo "Syncing docs config."; \
  rsync -lr -v doc-config/{bin,etc} -e "ssh -p $port" "${userdoc}@${server}":'~' ; \
else \
  exit 1; \
fi
Syncing docs config.
sending incremental file list
rsync: [sender] link_stat "/home/lkocman/Workspace/opensuse/doc-o-o/doc-config/etc" failed: No such file or directory (2)
bin/set_current_version

sent 129 bytes  received 42 bytes  342.00 bytes/sec
total size is 424  speedup is 2.48
rsync error: some files/attrs were not transferred (see previous errors) (code 23) at main.c(1330) [sender=3.2.3]
make: *** [Makefile:74: upload_doc_config] Error 23
lkocman@localhost:~/Workspace/opensuse/doc-o-o> 

Actions #2

Updated by lkocman over 1 year ago

Just to share my .ssh config for tracking of history

lkocman@localhost:/etc/openvpn> cat ~/.ssh/config 
Host pontifex
    Hostname  pontifex.infra.opensuse.org
    User lkocman
Host community
    Hostname  community.infra.opensuse.org
    User lkocman
Host pinot
    Hostname  pinot.infra.opensuse.org
    User relsync
Host alp
    Hostname 192.168.122.194
    User root
Host mirror
    Hostname mirror.luboskocman.com
    User root

Host openqa.opensuse.org
    HostName gate.opensuse.org
    Port 2213
    User lkocman

Actions #3

Updated by lkocman over 1 year ago

I suppose that these files should be also under git

relsync@community:~> cat etc/releasenotes 
# Configuration file for release notes from OBS to doc.o.o
# ========================================================
#
#(Only edit this file within the Git repo https://github.com/openSUSE/doc-o-o!
# Other changes may be overwritten.)
#
# Format:
# DISTVERSION|PRODUCT_NAME|PRODUCT_VERSION|RELEASE_NOTES_NAME|PRODUKT_ARCHS
#
# DISTVERSION        : openSUSE version (from OBS download tree like: obs://openSUSE:13.1:Update/standard)
# PRODUCT_NAME       : Name of the product (will appear in tree)
# PRODUCT_VERSION    : official Version number (12.3 or 13.1 - will appear in tree)
# RELEASE_NOTES_NAME : the name of the release-notes RPM
# PRODUKT_ARCHS      : supported architectures (space separated)
# TARGET_REL_DIRS    : target base directory where release notes should be unpacked (can/should stay empty)
#
# TODO: phase out factory and only provide Tumbleweed
obs://Documentation:Auto/openSUSE_Factory|openSUSE|factory|release-notes-openSUSE-TW|x86_64|
obs://Documentation:Auto/openSUSE_Factory|openSUSE|Tumbleweed|release-notes-openSUSE-TW|x86_64|
obs://Documentation:Auto/openSUSE_Leap_15.2|openSUSE|Leap/15.2|release-notes-openSUSE-L152|x86_64|
obs://Documentation:Auto/openSUSE_Leap_15.3|openSUSE|Leap/15.3|release-notes-openSUSE-L153|x86_64|
obs://Documentation:Auto/15.4|openSUSE|Leap/15.4|release-notes-openSUSE-L154|x86_64|

relsync@community:~> cat etc/update_release_notes.conf 
# Configuration file for update_release_notes
# update_release_notes is expected to run automatically and 
# - fetch multiple release-notes packages from OBS
# - copy and extract the packages into a given directory
# - generate an index.html file as overview
# The configuration file here should help with some basic 
# definitions, that might change - depending on the deployment
#

# The file with the list of RPMS
RELEASENOTES_DATA="$BASEDIR/etc/releasenotes"

# The directory to start the extraction of RPMS
RELNOTESDIR="$BASEDIR/release-notes"

# We want a logfile, if something goes wrong
LOGFILE="$BASEDIR/var/log/$(basename $0).log"

Actions #4

Updated by lkocman over 1 year ago

Making sure to not erase anything server-side

lkocman@localhost:~/Workspace/opensuse/doc-o-o/doc-config> scp -r relsync@community:/home/relsync/etc .
update_release_notes.conf                                                                                             100%  642    34.7KB/s   00:00    
releasenotes                                                                                                          100% 1340    60.6KB/s   00:00    
lkocman@localhost:~/Workspace/opensuse/doc-o-o/doc-config> ls
bin  etc
lkocman@localhost:~/Workspace/opensuse/doc-o-o/doc-config> 
# add 15.5
lkocman@localhost:~/Workspace/opensuse/doc-o-o/doc-config> tail -1 etc/releasenotes 
obs://Documentation:Auto/15.5|openSUSE|Leap/15.5|release-notes-openSUSE-L155|x86_64|

Actions #5

Updated by lkocman over 1 year ago

Now it finally passes

lkocman@localhost:~/Workspace/opensuse/doc-o-o> make set_docs_current_version 
test -s /home/lkocman/Workspace/opensuse/doc-o-o/publishusers && source /home/lkocman/Workspace/opensuse/doc-o-o/publishusers; \
if [[ $userdoc ]] && [[ $port ]] && [[ $server ]]; then \
  echo "Syncing docs config."; \
  rsync -lr -v doc-config/{bin,etc} -e "ssh -p $port" "${userdoc}@${server}":'~' ; \
else \
  exit 1; \
fi
Syncing docs config.
sending incremental file list
bin/set_current_version
etc/releasenotes
etc/update_release_notes.conf

sent 1,048 bytes  received 105 bytes  2,306.00 bytes/sec
total size is 2,491  speedup is 2.16
test -s /home/lkocman/Workspace/opensuse/doc-o-o/publishusers && source /home/lkocman/Workspace/opensuse/doc-o-o/publishusers; \
if [[ $userrn ]] && [[ $port ]]  && [[ $server ]] && [[ $version ]]; then \
    ssh -p "$port" "${userdoc}@${server}" "set_current_version $version" ; \
else \
    echo "The \"version\" variable is not set. Set it in the \"publishusers\" file."; exit 1; \
fi
Setting the current version to 15.5.
~/doc.opensuse.org/htdocs/documentation/leap ~
~
lkocman@localhost:~/Workspace/opensuse/doc-o-o> 

Actions #6

Updated by lkocman over 1 year ago

  • Status changed from New to In Progress
Actions #7

Updated by cboltz over 1 year ago

lkocman wrote:

I suppose that these files should be also under git

relsync@community:~> cat etc/releasenotes 

Not those on community.i.o.o ;-) - they are only there for historical reasons, and ununsed.

Nowadays the release notes live on pinot.o.o.

Actions #8

Updated by lkocman over 1 year ago

Actions #9

Updated by cboltz over 1 year ago

lkocman wrote:

most issues are blocked on https://progress.opensuse.org/issues/130661

That's unblocked since an hour.

Please also have a look at https://progress.opensuse.org/issues/130664 (wrong PDF link/filename on doc.o.o)

Actions

Also available in: Atom PDF