7 Star 0 Fork 38

src-openEuler / rsyslog

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

rsyslog-docs

Documentation for the rsyslog project

Documentation for rsyslog is generated with the (Python) Sphinx documentation processor. Documentation for the rsyslog-doc project itself is provided by this README and other documentation linked from this file.

Learning the doc tools

If you are new to rst and Sphinx, see the Sphinx documentation to get started: http://www.sphinx-doc.org/en/stable/contents.html

Contributed Software/Content

In the repo you will find a contrib directory.

Although content in this directory is part of the official rsyslog-doc repo, the status is different. While other content in this repo is fully supported by the dev team, content in the contrib directory is supported primarily by the contributor who provided it.

Content may range from small one-off scripts to tools for automating builds of the docs. See the contrib README for details.

If you have new things to add to this area, please follow the directions on this page for contributing to the docs and submit your changes as a new Pull Request.

Dev Team resources

In addition to the directions here, there is also a separate BUILDS_README.md file for use by rsyslog-doc team members. This doc is used as a quick reference for those who regularly provide dev and official release builds of the documentation.

Contributing to the docs

  1. Login with a GitHub account
  2. Fork the official https://github.com/rsyslog/rsyslog-doc repo
  3. Create a new branch off of the latest master branch
  4. Make your changes
  5. Commit to the new branch in your fork
  6. Submit a Pull Request (PR) for review (https://github.com/rsyslog/rsyslog-doc/pulls)
  7. Stop making any changes to your new branch now that you have submitted a Pull Request for review. Instead, create a new branch from your master branch while you wait for feedback from the doc team.
  8. A member of the team will review and offer feedback on your work. After feedback has been given and you have made all necessary changes, your PR will be accepted and merged into the official master branch.
  9. At this point, delete your branch that you submitted the PR from and start a new one for the next round of work.

For small changes, the work can be done entirely through the GitHub web interface. For larger changes, some familiarity with Git is useful, though some editors such as Atom or Visual Studio Code make interfacing with Git easier for newcomers.

Before you begin your work, you are encouraged to review the existing PRs and open issues so that you can coordinate your work with other contributors.

Please reach out if you have any questions as you work through making your changes.

Tip: If you would like something less complex to get started with, please see issues tagged with good first issue or help wanted

Requesting feedback/help

While working on changes to the docs, you are encouraged to seek input from other members of the community. This can be done via the mailing list, here on GitHub by submitting a new issue or (experimentally) by posting a question to Stack Exchange.

Building the documentation

These directions assume default installs of Python for Windows and Linux. Because the Sphinx project recommends using Python 2.7, that is what is shown here.

Assumptions

  • You wish to install the pip Python package as a standard user, which places installed packages into that user's home directory. Remove the --user flag if you wish to install system-wide for all users instead.

  • You wish to use a virtual environment to install Sphinx and its dependencies into a dedicated environment instead of installing alongside packages that were installed system-wide or to the user's home directory with the --user flag. If you wish to install the sphinx package and all dependent packages for all users of the system, then you will need to run the package installation commands as an elevated user account (e.g., sudo, su or with administrator rights on a Windows system).

  • You are running through these steps for the first time. Leave out the steps involving installation of packages and applications if generating an updated copy of the documentation.

Prep environment

The first part of the process is a little different depending on your OS. The later steps are identical, so those steps have been covered in one place.

Linux

  1. Download the pip installer from https://bootstrap.pypa.io/get-pip.py

  2. Install pip locally instead of system-wide

    1. python ./get-pip.py --user
  3. Install virtualenv package and create new virtual environment

    1. python -m pip install virtualenv --user
    2. python -m virtualenv rsyslog-docs-build
    3. source rsyslog-docs-build/bin/activate
  4. Install git for your distro. Because distros name the package differently, you may need to substitute the name of the package from the examples below with the name of the package for your distro.

    You will need to install Git in order to clone the project repo, manage your changes and contribute them back for review and eventual inclusion in the project.

    Example commands for installing Git:

    • Debian/Ubuntu: apt-get install git-core
    • CentOS/RHEL: yum install git

    See the Installing Git chapter from Pro Git 2 for additional examples.

Windows

  1. Download the pip installer from https://bootstrap.pypa.io/get-pip.py
  2. Download and install Git for windows from https://git-scm.com/download/win
  3. Install pip locally instead of system-wide
    1. c:\python27\python get-pip.py --user
  4. Install virtualenv package and create new virtual environment
    1. c:\python27\python -m pip install virtualenv --user
    2. c:\python27\python -m virtualenv rsyslog-docs-build
    3. rsyslog-docs-build\Scripts\activate.bat

Windows and Linux

  1. Install sphinx package and any other project dependencies in our new virtual environment instead of system-wide
    1. pip install -r requirements.txt
  2. Clone the official Git repo
    1. git clone https://github.com/rsyslog/rsyslog-doc.git
  3. Checkout either the current stable or development (aka, "master") branch
    1. cd rsyslog-doc
    2. git checkout BRANCH_NAME_HERE
      • Choose the v8-stable branch for coverage of features currently available in the latest stable release
      • Choose the master branch for coverage of upcoming features and fixes
  4. Optional: If you have previously cloned the repo, run git pull to update it with new changes before continuing.

Generate documentation

  1. Generate HTML format
    1. sphinx-build -b html source build
  2. Generate EPUB format
    1. sphinx-build -b epub source build
  3. Review generated contents
    • Open rsyslog-doc/build/index.html in a browser
    • Use Calibre, Microsoft Edge, Okular, Google Play Books or any other EPUB compatible reader to view the rsyslog-doc/build/rsyslog.epub file
NOTE: it is our intent to place new doc under the ASL 2.0 license. **However** at the time of this writing, the files are under different license. Please review the copyright section of each file to see which license applies. Below is a copy of the ASL 2.0. ------------------------------------------------------------------------------- Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

暂无描述 展开 收起
Shell
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/src-openeuler/rsyslog.git
git@gitee.com:src-openeuler/rsyslog.git
src-openeuler
rsyslog
rsyslog
master

搜索帮助