Skip to content

Commit

Permalink
fix(docs,lint): Fixed broken image in README and updated official sit…
Browse files Browse the repository at this point in the history
…e link , Resolved major lint issues across the repository
  • Loading branch information
Brijeshthummar02 authored and rzo1 committed Mar 1, 2025
1 parent 9b39f50 commit ef20590
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 44 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
What kind of issue is this?

- [ ] Question. This issue tracker is not the best place for questions. If you want to ask how to do
- [ ] Question. This issue tracker is not the best place for questions. If you want to ask how to do
something, or to understand why something isn't working the way you expect it to, use StackOverflow
instead with the label 'stormcrawler': https://stackoverflow.com/questions/tagged/stormcrawler
instead with the label 'stormcrawler': <https://stackoverflow.com/questions/tagged/stormcrawler>

- [ ] Bug report. If you’ve found a bug, please include a test if you can, it makes it a lot easier to fix things. Use the label 'bug' on the issue.
- [ ] Feature request. Please use the label 'wish' on the issue.
- [ ] Bug report. If you’ve found a bug, please include a test if you can, it makes it a lot easier to fix things. Use the label 'bug' on the issue.

- [ ] Feature request. Please use the label 'wish' on the issue.

Thanks!
9 changes: 5 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,26 @@ Thank you for contributing to Apache StormCrawler.
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

### For all changes:
### For all changes

- [ ] Is there a issue associated with this PR? Is it referenced in the commit message?

- [ ] Does your PR title start with `#XXXX` where `XXXX` is the issue number you are trying to resolve?
- [ ] Does your PR title start with `#XXXX` where `XXXX` is the issue number you are trying to resolve?

- [ ] Has your PR been rebased against the latest commit within the target branch (typically main)?

- [ ] Is your initial contribution a single, squashed commit?

- [ ] Is the code properly formatted with `mvn git-code-format:format-code -Dgcf.globPattern="**/*" -Dskip.format.code=false`?

### For code changes:
### For code changes

- [ ] Have you ensured that the full suite of tests is executed via `mvn clean verify`?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the LICENSE file, including the main LICENSE file?
- [ ] If applicable, have you updated the NOTICE file, including the main NOTICE file?

### Note

### Note:
Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.
13 changes: 6 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,34 +9,33 @@ To make the process smooth for the project *committers* (those who review and ac

We use GitHub Issues and Pull Requests for tracking contributions. We
expect participants to adhere to the GitHub Community Guidelines (found
at https://help.github.com/articles/github-community-guidelines/ ).
at <https://help.github.com/articles/github-community-guidelines/> ).

### Get Involved

The Apache StormCrawler project is developed by volunteers and is always looking for new contributors to work on all parts of the project.
The Apache StormCrawler project is developed by volunteers and is always looking for new contributors to work on all parts of the project.
Every contribution is welcome and needed to make it better. A contribution can be anything from a small documentation typo fix to a new component. We especially welcome contributions from first-time users.

#### Mailing Lists

To get started, please first join the Apache StormCrawler mailing lists:

#### [email protected]
#### <[email protected]>

This list is for development discussions, patch suggestions, and current issues posted to the issue tracker for the project.

- [Subscribe]([email protected])
- [Unsubscribe]([email protected])
- [Archives](https://lists.apache.org/[email protected])

#### [email protected]
#### <[email protected]>

This list follows changes to the project. This list is not for questions. This list is used by git to post changes to the project. If you have questions about any content here, post them to the stormcrawler-dev list above.

- [Subscribe]([email protected])
- [Unsubscribe]([email protected])
- [Archives](https://lists.apache.org/[email protected])


#### GitHub Discussions

Feel free to use GitHub Discussions to ask any questions you might have when planning your first contribution.
Expand All @@ -52,8 +51,8 @@ Further details on using the ASF Slack channels and associated expectations can
### Making a Contribution

- Create a new issue on GitHub. Please describe the problem or improvement in the body of the issue. For larger issues, please first contact the developer mailing list and describe the problem.
- Next, create a pull request in GitHub.
- Next, create a pull request in GitHub.

Bigger contributions can eventually only be accepted when an [ICLA, CCLA or software grant](https://www.apache.org/licenses/contributor-agreements.html) is on file.

Contributors who have a history of successful participation are invited to join the project as a committer from the PPMC.
Contributors who have a history of successful participation are invited to join the project as a committer from the PPMC.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![StormCrawler](http://stormcrawler.net/img/Logo-small.jpg)](http://stormcrawler.net/)
[![StormCrawler](https://stormcrawler.apache.org/img/Logo-small.jpg)](https://stormcrawler.apache.org/)
=============

[![license](https://img.shields.io/github/license/apache/incubator-stormcrawler.svg?maxAge=2592000?style=plastic)](http://www.apache.org/licenses/LICENSE-2.0)
Expand All @@ -13,7 +13,7 @@ NOTE: These instructions assume that you have [Apache Maven](https://maven.apach

StormCrawler requires Java 11 or above. To execute tests, it requires you to have a locally installed and working Docker environment.

Once Storm is installed, the easiest way to get started is to generate a new StormCrawler project following the instructions below:
Once Storm is installed, the easiest way to get started is to generate a new StormCrawler project following the instructions below:

```shell
mvn archetype:generate -DarchetypeGroupId=org.apache.stormcrawler -DarchetypeArtifactId=stormcrawler-archetype -DarchetypeVersion=3.2.0
Expand All @@ -34,9 +34,9 @@ The [WIKI](https://github.com/apache/incubator-stormcrawler/wiki) is a good plac

The project website has a page listing companies providing [commercial support](https://stormcrawler.apache.org/support/) for Apache StormCrawler.

## Note for developers
## Note for developers

Please format your code before submitting a PR with
Please format your code before submitting a PR with

```
mvn git-code-format:format-code -Dgcf.globPattern="**/*" -Dskip.format.code=false
Expand Down
48 changes: 24 additions & 24 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
## Release Preparation

- Select a release manager on the dev mailing list. A release manager should be a committer and should preferably switch between releases to have a transfer in knowledge.
- Create an issue for a new release in https://github.com/apache/incubator-stormcrawler/issues
- Create an issue for a new release in <https://github.com/apache/incubator-stormcrawler/issues>
- Review all [issues](https://github.com/apache/incubator-stormcrawler/issues) associated with the release. All issues should be resolved and closed.
- Any issues assigned to the release that are not complete should be assigned to the next release. Any critical or blocker issues should be resolved on the mailing list. Discuss any issues that you are unsure of on the mailing list.

## Steps for the Release Manager

The following steps need only to be performed once.

- Make sure you have your PGP fingerprint added into https://id.apache.org/
- Make sure you have your PGP fingerprint added into <https://id.apache.org/>
- Make sure you have your PGP keys password.
- Add your PGP key to the [KEYS](https://dist.apache.org/repos/dist/release/incubator/stormcrawler/KEYS) file.
- Add your PGP key to the [KEYS](https://dist.apache.org/repos/dist/release/incubator/stormcrawler/KEYS) file.

Examples of adding your key to this file:

Expand Down Expand Up @@ -93,25 +93,24 @@ export GPG_TTY=$(tty)
This command creates and pushes two new commits to the repository to reflect the version changes. It also tags the release and pushes the branch.
- Check the result of the GitHub action runs.


### Successful Maven Release Preparation

#### Perform the Release

- Perform the release: `mvn release:perform -Papache-gpg`
- This creates a staged repository at https://repository.apache.org/#stagingRepositories
- This creates a staged repository at <https://repository.apache.org/#stagingRepositories>
- Check the staged repository and if all looks well, close the staging repository but do *not* promote or release it at this time.
- The build results are in `stormcrawler/target/`. Do not modify or delete these files.

##### Put the artifacts to dist/dev

- Next, checkout the svn dist dev space from https://dist.apache.org/repos/dist/dev/incubator/stormcrawler
- Next, checkout the svn dist dev space from <https://dist.apache.org/repos/dist/dev/incubator/stormcrawler>
- Create a new folder `stormcrawler-x.y.z-RC1`.
- Add the `apache-stormcrawler-VERSION-incubating-source-release*` files from `stormcrawler/target/` to this folder.
- `echo " apache-stormcrawler-3.2.0-incubating-source-release.tar.gz" >> apache-stormcrawler-3.2.0-incubating-source-release.tar.gz.sha512`
- `echo " apache-stormcrawler-3.2.0-incubating-source-release.zip" >> apache-stormcrawler-3.2.0-incubating-source-release.zip.sha512`
- Ensure to add the file name to the `sha512` signature of the `apache-stormcrawler-VERSION-incubating-source-release*.zip.sha512` file as this is not automatically done via Maven.
- Commit the change set to the dist area (commit message "adding X.Y.Z-RC1"). Check that the files are present in https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z-RC1
- Commit the change set to the dist area (commit message "adding X.Y.Z-RC1"). Check that the files are present in <https://dist.apache.org/repos/dist/dev/incubator/stormcrawler/stormcrawler-x.y.z-RC1>

#### Check the Release Artifacts

Expand Down Expand Up @@ -150,12 +149,13 @@ gpg --homedir . --output apache-stormcrawler-x.y.z-incubating-source-release.ta

- Create a separate branch for the release.
- Run a global replace of the old version with the new version.
- Prepare a preview via the staging environment of the website.
- Ensure the website is updated on https://stormcrawler.staged.apache.org
- Note: Instruction on how to do so can be found on https://github.com/apache/incubator-stormcrawler-site
- Prepare a preview via the staging environment of the website.
- Ensure the website is updated on <https://stormcrawler.staged.apache.org>
- Note: Instruction on how to do so can be found on <https://github.com/apache/incubator-stormcrawler-site>

### Create a draft release on Github
- Create a new Draft Release -- on https://github.com/apache/incubator-stormcrawler/releases, click `Draft a new release` and select the `stormcrawler-X.Y.Z` tag.

- Create a new Draft Release -- on <https://github.com/apache/incubator-stormcrawler/releases>, click `Draft a new release` and select the `stormcrawler-X.Y.Z` tag.
- Click the `Generate Release Notes` (**MAKE SURE TO SELECT THE CORRECT PREVIOUS RELEASE AS THE BASE**). Copy and paste the Disclaimer and Release Summary from the previous release and update the Release Summary as appropriate.
- Click the `Set as pre-release` button.
- Click `Publish release`. The release should not have `*-rc1` in its title, e.g.: `https://github.com/apache/incubator-stormcrawler/releases/tag/stormcrawler-3.2.0`
Expand All @@ -164,8 +164,8 @@ gpg --homedir . --output apache-stormcrawler-x.y.z-incubating-source-release.ta

The VOTE process is two-fold:

- (1) Create a community vote on [email protected]
- (2) If this vote is successful, the actual vote can be started on [email protected]
- (1) Create a community vote on <[email protected]>
- (2) If this vote is successful, the actual vote can be started on <[email protected]>

- Be sure to replace all values in `[]` with the appropriate values.

Expand Down Expand Up @@ -245,7 +245,7 @@ Thanks!
## After a Successful Vote
The vote is successful if at least 3 _+1_ votes are received from IPMC members after a minimum of 72 hours of sending the vote email.
The vote is successful if at least 3 *+1* votes are received from IPMC members after a minimum of 72 hours of sending the vote email.
Acknowledge the voting results on the mailing list in the VOTE thread by sending a mail.
```bash
Expand All @@ -269,7 +269,7 @@ Thanks to all voters. I'll proceed with the steps.
### Release Nexus Staging Repository
Release the staging repository. This will make the artifacts available in the Maven Central repository.
To do this go to the https://repository.apache.org[repository server], log in, go to the staging area and release the staging repository linked to this release
To do this go to the <https://repository.apache.org[repository> server], log in, go to the staging area and release the staging repository linked to this release
### Merge the Release Branch
Expand All @@ -287,15 +287,15 @@ This will make the release artifacts available on dist.apache.org and the artifa
### Delete Old Release(s)
To reduce the load on the ASF mirrors, projects are required to delete old releases (see https://www.apache.org/legal/release-policy.html#when-to-archive).
To reduce the load on the ASF mirrors, projects are required to delete old releases (see <https://www.apache.org/legal/release-policy.html#when-to-archive>).
Remove the old releases from SVN under https://dist.apache.org/repos/dist/release/incubator/stormcrawler/.
Remove the old releases from SVN under <https://dist.apache.org/repos/dist/release/incubator/stormcrawler/>.
### Update the Website
- Merge the release branch to `main` to start the website deployment.
- Merge the release branch to `main` to start the website deployment.
- Check, that the website is deployed successfully.
- Instruction on how to do so can be found on https://github.com/apache/incubator-stormcrawler-site
- Instruction on how to do so can be found on <https://github.com/apache/incubator-stormcrawler-site>
### Make the release on Github
Expand All @@ -304,9 +304,9 @@ Remove the old releases from SVN under https://dist.apache.org/repos/dist/releas
### Post-Release Steps
- Close the present release ticket
- Send an announcement email to [email protected], [email protected], [email protected].
- Send an announcement email to <[email protected]>, <[email protected]>, <[email protected]>.
- Make sure the mail is **plain-text only**.
- It needs to be sent from your **@apache.org** email address or the email will bounce from the announce list.
- It needs to be sent from your **@apache.org** email address or the email will bounce from the announce list.
```bash
Title: [ANNOUNCE] Apache StormCrawler (Incubating) <version> released
Expand Down Expand Up @@ -339,8 +339,8 @@ The Apache StormCrawler Team
The release vote may fail due to an issue discovered in the release candidate. If the vote fails the release should be canceled by:
- Sending an email to [email protected] and [email protected] on the VOTE thread notifying of the vote's cancellation.
- Dropping the staging repository at https://repository.apache.org/.
- Sending an email to <[email protected]> and <[email protected]> on the VOTE thread notifying of the vote's cancellation.
- Dropping the staging repository at <https://repository.apache.org/>.
- Renaming the `stormcrawler-x.y.x` tag to `stormcrawler-x.y.z-RC1`.
A new release candidate can now be prepared. When complete, a new VOTE thread can be started as described in the steps above.
A new release candidate can now be prepared. When complete, a new VOTE thread can be started as described in the steps above.

0 comments on commit ef20590

Please sign in to comment.