suse/technical-reference-documentation

SUSE Technical Reference Documentation

technical-reference-documentation's Issues

[doc] Issue in "Rancher by SUSE and Priority Support on AWS Marketplace"

Rancher by SUSE and Priority Support on AWS Marketplace:

https://documentation.suse.com/trd/kubernetes/html/gs_rancher_aws-marketplace/index.html#

Terry is an author. I'm sorry, I thought I fixed this. Please change:

Contributor
Terry Smith, Global Partner Solutions Director (SUSE)

to read -

Authors
Kevin Ayres, Solutions Architect (SUSE)
Terry Smith, Global Partner Solutions Director (SUSE)

Contributor
Stephen Mogg, Solutions Architect (SUSE)
Contributor
Keith Pettit, Sales Engineer (SUSE)

[doc] Issue in "Rancher by SUSE and Priority Support on AWS Marketplace" - please remove

Rancher by SUSE and Priority Support on AWS Marketplace:

https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/?_gl=1*oz4ro9*_ga*MTc4NDkyMDgzMy4xNzA1NjA2NDM5*_ga_Y7SFXF9L00*MTcwNjMwMzY4MC40LjEuMTcwNjMwOTE5Ny41Ny4wLjA.#id-1

Can we please remove this TRD? There is a new Marketplace Listing for Rancher and this no longer applies. The new instructions are contained within the listing.

[doc] Issue in "Building a container image"

Building a container image:

https://documentation.suse.com/trd/linux/single-html/gs_sles_ibm-hpvs/#id-building-a-container-image

In order to build with the BCI image you need to add a line to checkout the 'slebci-paynow-website' branch, otherwise it will pull from upstream node19

git clone https://github.com/mfriesenegger/paynow-website.git
cd paynow-website
git checkout slebci-paynow-website /*add this line */

[doc] Issue in "NVIDIA GPU Driver and NVIDIA GPU Operator with SUSE"

NVIDIA GPU Driver and NVIDIA GPU Operator with SUSE:

https://documentation.suse.com/trd/kubernetes/html/gs_rke2-slebci_nvidia-gpu-operator/index.html#

Hello,

I'm trying to create a container image for the nvidia gpu operator.

Code:

cat <<EOF> /tmp/build-variables.sh
export REGISTRY="my.repo.url.com/docker-local/nvidia"
export SLE_VERSION="15"
export SLE_SP="5"
export DRIVER_VERSION="550.54.14"
export OPERATOR_VERSION="v23.9.0"
export CUDA_VERSION="12.4.1"
EOF

source /tmp/build-variables.sh

git clone https://gitlab.com/nvidia/container-images/driver/ && cd driver/sle15

sed -i "/^FROM/ s/golang\:1\.../golang\:1.22/" Dockerfile

sed -i '/^FROM/ s/suse\/sle15/bci\/bci-base/' Dockerfile

sudo podman build -t \
${REGISTRY}/nvidia-sle${SLE_VERSION}sp${SLE_SP}-${DRIVER_VERSION}:${DRIVER_VERSION} \
  --build-arg SLES_VERSION="${SLE_VERSION}.${SLE_SP}" \
  --build-arg DRIVER_ARCH="x86_64" \
  --build-arg DRIVER_VERSION="${DRIVER_VERSION}" \
  --build-arg CUDA_VERSION="${CUDA_VERSION}" \
  --build-arg PRIVATE_KEY=empty  \
.

Once the container image gets deployed only the repository SLE_BCI is enabled and does not contain any kernel-default packages.
Once I enable the other repositories, the kernel-default is available, but only as src-package.

Also a ".1" is missing in the version string to install the package.

Can you please update the documentation, or the base container image?

Regards!

EDIT: I just changed the format of code to code ^^

[doc] Issue in "Priority support"

Priority support:

https://documentation.suse.com/trd/kubernetes/html/gs_rancher_aws-marketplace/index.html#id-priority-support

The corrected URL for the SCC is https://scc.suse.com/cloudsupport

[doc] 5.1 Basic authentication

5.1 Basic authentication:

https://documentation.suse.com/trd/kubernetes/html/kubernetes_gs_rancher_veeam-kasten/index.html#id-basic-authentication

There is a typo in the URL for the basic authentication link. It should be "https://docs.kasten.io/latest/access/authentication.html#id6"

ID issues found by CI

@bwgartner For SEO reasons, we have moved (most of) the SUSE docs to using IDs that only contain the characters a-z0-9-. The CI is checking that by default & that's why it is failing currently. There are two options here:

1. Disable the check (we currently do that on the SBP repo)
2. Update the IDs

Longer-term, I'd definitely prefer (1), but shorter-term, we can do (2) if this is easier for you right now--that option adds just a single line to our GitHub Actions workflow.
What do you think?

[doc] Issue in "MongoDB Enterprise with SUSE Rancher" - out-of-date

MongoDB Enterprise with SUSE Rancher:

https://documentation.suse.com/trd/kubernetes/single-html/kubernetes_gs_rancher_mongodb-enterprise/#id-1

This documentation is out-of-date, featuring unsupported components.

@chabowski : Can you facilitate archiving this documentation?

Prepare for the new TRD stylesheets

Situation

Soon we will have some new TRD stylesheets. To use the full potential, we need to change or add some metadata.

Proposed solution

• Correct the list of authors. If you have more than one author, put them all into an <authorgroup> element. The order matters (first come, first displayed):

  <authorgroup>
     <author>
        <personname>
           <firstname>Tux</firstname>
           <surname>Penguin</surname>
           <affiliation>
              <jobtitle>Chief Cuteness Officer</jobtitle>
              <orgname>SUSE</orgname>
           </affiliation>
        </personname>
     </author>
    <!-- ... add more ... -->
  </authorgroup>

• If you wish, add some company logos with <cover> and <mediaobject>. The logos should be added to the imagesdirectory.

  <cover>
     <mediaobject>
         <imagedata fileref="..." width="4em"/>
     </mediaobject>
     <!-- add more, if needed -->
  </cover>
  

• If you have logos, add the width of your logos (in <cover>). If you leave it out, the logos could potentially grow too big. Start with:

  <imagedata fileref="..." width="4em"/>
  

• Add one or more platform meta information. This should contain the platform where this paper applies (for example, SLES 15 SP5). If you don't need it, leave it out:

  <meta name="platform">...</meta>
  

• Add one element for series meta information (should contain "Technical Reference Documentation"):

  <meta name="series">...</meta>
  

  I would recommend to add a placeholder to avoid typos (for example, {trd}). That could be done in common/adoc/common_docinfo_vars.adoc I suppose with:

  :trd: Technical Reference Documentation
  

• Add category meta information (something like Systems Management, Edge, SAP etc.):

  <meta name="category">...</meta>
  

• Add type meta information (something like "Getting Started", "Reference Implementation" etc.):

  <meta name="type">...</meta>
  

• If feasible, shorten titles and add possible subtitles. This will improve our SEO ratings.

• Keep your fingers crossed. 😉

[doc] Prerequisites

Prerequisites:

https://documentation.suse.com/trd/linux/html/gs_sles_jupyter-jupyterlab/index.html#id-prerequisites

Python 3.6 is included with SLES 15 SP4 and is used in this guide. This is adequate to run JupyterLab and many ML toolkits.

endoflife.date/python: Python 3.6 support ended 11 months ago. Accordingly, many ML toolkits don't support it anymore.

One popular example, scikit-learn, doesn't even support 3.7. Currently, 3.9 seems to best supported python version with the longest remaining support. It's also the default version for the current anaconda distribution.

[doc] Issue in "Upgrade to latest version"

Upgrade to latest version:

https://documentation.suse.com/trd/kubernetes/single-html/gs_rancher_aws-marketplace/#id-upgrade-to-latest-version

It should be mentioned in this Section that the Helm deployment name is rancher-stable if Rancher Setup was used. The linked Rancher guide assumes that it's named rancher, which will lead to a situation that the commands fail and the customer has to dig deeper to figure out the right name.

[doc] Issue in "Setting up WordPress"

Setting up WordPress:

https://documentation.suse.com/trd/linux/html/linux_gs_wordpress-lamp-sles/index.html#id-setting-up-wordpress

The command in step 4 says to copy to /src/www/htdocs/wp-config.php rather than the srv directory, which causes the command to fail.

[doc] Issue in "Generate the framework"

Generate the framework:

https://documentation.suse.com/trd/contributors/single-html/suse-trd_contrib-guide/#id-generate-the-framework

4. Execute the setup script to generate directory structures and basic files from templates.

bin/gssetup.sh
^^^
This is not the right path - pls. show the full path or relative - to be able to cut'n'paste